java.lang.Object

nz.org.riskscape.engine.types.RSList

All Implemented Interfaces:: ContainingType, Type

public class RSList extends Object implements Type, ContainingType

Basic list type that can convert various arrays and list types to the required type

Field Summary

Fields

Modifier and Type

Field

Description

static final RSList

LIST_ANYTHING

static final ComplexTypeConstructor

TYPE_CONSTRUCTOR

static final TypeInformation

TYPE_INFORMATION
Constructor Summary

Constructors

Modifier

Constructor

Description

RSList(Type memberType)

Deprecated.
use create(Type) instead - reduces the amount of identical types being allocated All Riskscape code has been ported to use create, but there may be functions etc out there that are using this old constructor.

protected

RSList(Type memberType, boolean ignored)

Internal, non-deprecated constructor - ignored flag is here just to provide a non-deprecated alternative
Method Summary

Modifier and Type

Method

Description

Struct

asStruct()

Object

coerce(Object value)

Attempt to convert the given value in to one represented by this type.

static RSList

create(Type memberType)

boolean

equals(Object obj)

int

estimateSize(Object entry)

Estimate the number of bytes used to serialize the given value to an output stream.

Object

fromBytes(DataInputStream in)

Type

getContainedType()

Type

getMemberType()

int

hashCode()

Class<?>

internalType()

The underlying java class used to represent this type.

void

toBytes(DataOutputStream os, Object toWrite)

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nz.org.riskscape.engine.types.ContainingType
visit

Methods inherited from interface nz.org.riskscape.engine.types.Type
checkForNull, find, findAllowNull, getUnwrappedType, isA, isNullable, isNumeric, isWrapped, toString, unwrap

Field Details
- LIST_ANYTHING
  
  public static final RSList LIST_ANYTHING
- TYPE_CONSTRUCTOR
  
  public static final ComplexTypeConstructor TYPE_CONSTRUCTOR
- TYPE_INFORMATION
  
  public static final TypeInformation TYPE_INFORMATION
Constructor Details
- RSList
  
  @Deprecated public RSList(Type memberType)
  
  Deprecated.
  use create(Type) instead - reduces the amount of identical types being allocated All Riskscape code has been ported to use create, but there may be functions etc out there that are using this old constructor. We might want to log a stack trace when this is used if it becomes functionally important that the new static constructor be used.
- RSList
  
  protected RSList(Type memberType, boolean ignored)
  
  Internal, non-deprecated constructor - ignored flag is here just to provide a non-deprecated alternative
Method Details
- create
  
  public static RSList create(Type memberType)
- coerce
  
  public Object coerce(Object value) throws CoercionException
  
  Description copied from interface: Type
  
  Attempt to convert the given value in to one represented by this type.
  
  Specified by:
  
  coerce in interface Type
  
  Parameters:
  
  value - The value to coerce
  
  Returns:
  
  A value that conforms to this type
  
  Throws:
  
  CoercionException - if the given object can not be converted to something represented by this type
- internalType
  
  public Class<?> internalType()
  
  Description copied from interface: Type
  
  The underlying java class used to represent this type.
  
  Specified by:
  
  internalType in interface Type
- asStruct
  
  public Struct asStruct()
  
  Specified by:
  
  asStruct in interface Type
- getMemberType
  
  public Type getMemberType()
- estimateSize
  
  public int estimateSize(Object entry)
  
  Description copied from interface: Type
  
  Estimate the number of bytes used to serialize the given value to an output stream.
  
  Specified by:
  
  estimateSize in interface Type
  
  Parameters:
  
  entry - the value of this type to measure. Must be of Type.internalType() or a ClassCastException is going to happen
  
  Returns:
  
  the estimated number of bytes, or zero if no estimation was possible.
- toBytes
  
  public void toBytes(DataOutputStream os, Object toWrite) throws IOException
  
  Specified by:
  
  toBytes in interface Type
  
  Throws:
  
  IOException
- fromBytes
  
  public Object fromBytes(DataInputStream in) throws IOException
  
  Specified by:
  
  fromBytes in interface Type
  
  Throws:
  
  IOException
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- getContainedType
  
  public Type getContainedType()
  
  Specified by:
  
  getContainedType in interface ContainingType
  
  Returns:
  
  The type that this ContainingType contains.

Class RSList

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nz.org.riskscape.engine.types.ContainingType

Methods inherited from interface nz.org.riskscape.engine.types.Type

Field Details

LIST_ANYTHING

TYPE_CONSTRUCTOR

TYPE_INFORMATION

Constructor Details

RSList

RSList

Method Details

create

coerce

internalType

asStruct

getMemberType

estimateSize

toBytes

fromBytes

toString

hashCode

equals

getContainedType