java.lang.Object

nz.org.riskscape.engine.typeset.IdentifiedType

All Implemented Interfaces:: Identified, Type, WrappingType

Direct Known Subclasses:: CanonicalType, LinkedType

public abstract class IdentifiedType extends Object implements Identified, Type, WrappingType

Wraps a type to include an identifier and a TypeSet to link it back to some managed and identified set of types among a set.

An IdentifiedType is equal iff the id, typeSet and subclass all match

Constructor Summary

Constructors

Constructor

Description

IdentifiedType(String id)
Method Summary

Modifier and Type

Method

Description

Object

coerce(Object value)

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

boolean

equals(Object rhs)

int

estimateSize(Object entry)

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

Object

fromBytes(DataInputStream in)

String

getId()

abstract TypeSet

getTypeSet()

abstract Type

getUnderlyingType()

int

hashCode()

Class<?>

internalType()

The underlying java class used to represent this type.

<T extends Type> boolean

isA(Class<T> type)

static Type

strip(Type type)

Strips off an outer IdentifiedType from the given type (if present)

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.Identified
getIdentifiedClass

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

Methods inherited from interface nz.org.riskscape.engine.types.WrappingType
asStruct, isNullable, visit

Constructor Details
- IdentifiedType
  
  public IdentifiedType(String id)
Method Details
- strip
  
  public static Type strip(Type type)
  
  Strips off an outer IdentifiedType from the given type (if present)
- getUnderlyingType
  
  public abstract Type getUnderlyingType()
  
  Specified by:
  
  getUnderlyingType in interface WrappingType
  
  Returns:
  
  the type that we immediately wrap. Used by Type.getUnwrappedType() to descend through all wrapped Type to find the first unwrapped one.
- getTypeSet
  
  public abstract TypeSet getTypeSet()
- coerce
  
  public Object coerce(Object value)
  
  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
- internalType
  
  public Class<?> internalType()
  
  Description copied from interface: Type
  
  The underlying java class used to represent this type.
  
  Specified by:
  
  internalType in interface Type
- isA
  
  public <T extends Type> boolean isA(Class<T> type)
  
  Specified by:
  
  isA in interface Type
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- equals
  
  public boolean equals(Object rhs)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- 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
  
  Specified by:
  
  estimateSize in interface WrappingType
  
  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
  
  Specified by:
  
  toBytes in interface WrappingType
  
  Throws:
  
  IOException
- fromBytes
  
  public Object fromBytes(DataInputStream in) throws IOException
  
  Specified by:
  
  fromBytes in interface Type
  
  Specified by:
  
  fromBytes in interface WrappingType
  
  Throws:
  
  IOException
- getId
  
  public String getId()
  
  Specified by:
  
  getId in interface Identified
  
  Returns:
  
  id

Class IdentifiedType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nz.org.riskscape.engine.Identified

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

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

Constructor Details

IdentifiedType

Method Details

strip

getUnderlyingType

getTypeSet

coerce

internalType

isA

toString

equals

hashCode

estimateSize

toBytes

fromBytes

getId