Package gnu.kawa.reflect

Class OccurrenceType

java.lang.Object

gnu.bytecode.Type

gnu.kawa.reflect.OccurrenceType

All Implemented Interfaces:

TypeValue, Externalizable, Serializable, Type

Direct Known Subclasses:

MultValuesType, NodeSetType

public class OccurrenceType
extends Type
implements Externalizable, TypeValue

A type that matches some number of repetitions of a basetype.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class gnu.bytecode.Type

Type.NeverReturns

Field Summary

Fields

Modifier and Type	Field	Description
static final Type	emptySequenceType
static final ClassType	typeOccurrenceType

Fields inherited from class gnu.bytecode.Type

boolean_ctype, boolean_type, booleanType, booleanValue_method, byte_type, byteType, char_type, charType, clone_method, double_type, doubleType, doubleValue_method, errorType, float_type, floatType, floatValue_method, int_type, intType, intValue_method, java_lang_Class_type, javalangannotationAnnotationType, javalangBooleanType, javalangCharacterType, javalangClassType, javalanginvokeMethodHandleType, javalangNumberType, javalangObjectType, javalangStringType, javalangThrowableType, long_type, longType, longValue_method, neverReturnsType, nullType, number_type, objectType, pointer_type, reflectClass, short_type, shortType, string_type, throwable_type, toString_method, tostring_type, toStringType, typeArray0, void_type, voidType

Constructor Summary

Constructors

Constructor	Description
OccurrenceType(Type base, int minOccurs, int maxOccurs)

Method Summary

Modifier and Type	Method	Description
Object	coerceFromObject(Object obj)	Convert an object to a value of this Type.
int	compare(Type other)	Return a numeric code showing "subtype" relationship: 1: if other is a pure subtype of this; 0: if has the same values; -1: if this is a pure subtype of other; -2: if they have values in common but neither is a subtype of the other; -3: if the types have no values in common.
static int	compatibleWithCount(Type type, int count)
Expression	convertValue(Expression value)	Return converted expression or null.
void	emitIsInstance(Variable incoming, Compilation comp, Target target)	Emit code for incoming instanceof this_type.
void	emitTestIf(Variable incoming, Declaration decl, Compilation comp)	Emit code for if (incoming instanceof this_type) decl = incoming ....
Type	getBase()
Procedure	getConstructor()	Get the constructor function for this type.
Type	getImplementationType()	Return Java-level implementation type.
static Type	getInstance(Type base, int minOccurs, int maxOccurs)
boolean	isInstance(Object obj)
static char	itemCountCode(Type type)	Returna a quantifer kind for a sequence type.
static boolean	itemCountIsOne(Type type)
static boolean	itemCountIsZeroOrOne(Type type)
static int	itemCountMax(Type type)
static int	itemCountMin(Type type)
static int	itemCountRange(Type type)	Return a conservative estimate on the min/max number of items of a type.
static Type	itemPrimeType(Type type)	XQuery formal semantics "prime type"
int	maxOccurs()
int	minOccurs()
void	readExternal(ObjectInput in)
protected void	setBase(Type base)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class gnu.bytecode.Type

coerceToObject, emitCoerceFromObject, emitCoerceToObject, emitConvertFromPrimitive, emitIsInstance, getGenericSignature, getMaybeGenericSignature, getName, getRawType, getRealType, getReflectClass, getSignature, getSize, getSizeInWords, getType, hashCode, isCompatibleWithValue, isCompatibleWithValue, isExisting, isInterface, isMoreSpecific, isSame, isSubtype, isValidJavaTypeName, isVoid, lookupType, lowestCommonSharedType, lowestCommonSuperType, make, make, printSignature, promote, promoteIfUnsigned, registerTypeForClass, setGenericSignature, setName, setReflectClass, setSignature, signatureLength, signatureLength, signatureToName, signatureToPrimitive, signatureToType, signatureToType, swappedCompareResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.reflect.Type

getTypeName

Methods inherited from interface gnu.expr.TypeValue

encodeType

Field Details

emptySequenceType

public static final Type emptySequenceType

typeOccurrenceType

public static final ClassType typeOccurrenceType

Constructor Details

OccurrenceType

public OccurrenceType(Type base,
 int minOccurs,
 int maxOccurs)

Method Details

getBase

public Type getBase()

setBase

protected void setBase(Type base)

minOccurs

public int minOccurs()

maxOccurs

public int maxOccurs()

getInstance

public static Type getInstance(Type base,
 int minOccurs,
 int maxOccurs)

getImplementationType

public Type getImplementationType()

Description copied from class: Type

Return Java-level implementation type. The type used to implement types not natively understood by the JVM or the Java language. Usually, the identity function. However, a language might handle union types or template types or type expressions calculated at run time. In that case return the type used at the Java level, and known at compile time.

Specified by:

getImplementationType in interface TypeValue

Overrides:

getImplementationType in class Type

compare

public int compare(Type other)

Description copied from class: Type

Return a numeric code showing "subtype" relationship: 1: if other is a pure subtype of this; 0: if has the same values; -1: if this is a pure subtype of other; -2: if they have values in common but neither is a subtype of the other; -3: if the types have no values in common. "Same values" is rather loose; by "A is a subtype of B" we mean that all instance of A can be "widened" to B. More formally, A.compare(B) returns: 1: all B values can be converted to A without a coercion failure (i.e. a ClassCastException or overflow or major loss of information), but not vice versa. 0: all A values can be converted to B without a coercion failure and vice versa; -1: all A values can be converted to B without a coercion failure but not vice versa; -2: there are (potentially) some A values that can be converted to B, and some B values can be converted to A; -3: there are no A values that can be converted to B, and neither are there any B values that can be converted to A.

Specified by:

compare in class Type

coerceFromObject

public Object coerceFromObject(Object obj)

Description copied from class: Type

Convert an object to a value of this Type. The result is actually of the implementation type, boxed as appropriate, so it is suitable for standard reflective operations, like the arguments to Field#set or Method#invoke. Throw a ClassCastException when this is not possible.

Specified by:

coerceFromObject in class Type

isInstance

public boolean isInstance(Object obj)

Overrides:

isInstance in class Type

emitTestIf

public void emitTestIf(Variable incoming,
 Declaration decl,
 Compilation comp)

Description copied from interface: TypeValue

Emit code for if (incoming instanceof this_type) decl = incoming .... This method is designed for typeswitch applications, where this call is the first part of a conditional, so it must be followed by calls to emitElse and emitFi.

Specified by:

emitTestIf in interface TypeValue

Parameters:

incoming - Contains the value we are testing to see if it has the type of this. If null, use top-of-stack. May not be null if decl is non-null.

decl - If non-null, assign value after coercion to Declaration.

comp - The compilation state.

emitIsInstance

public void emitIsInstance(Variable incoming,
 Compilation comp,
 Target target)

Description copied from interface: TypeValue

Emit code for incoming instanceof this_type. The implementation can use InstanceOf .emitIsInstance which is a conveniece method that calls emitTestIf.

Specified by:

emitIsInstance in interface TypeValue

Parameters:

incoming - Contains the value we are testing to see if it has the the type of 'this'. If null, use top-of-stack.

comp - The compilation state.

target - Where to leave the result.

convertValue

public Expression convertValue(Expression value)

Description copied from interface: TypeValue

Return converted expression or null.

Specified by:

convertValue in interface TypeValue

getConstructor

public Procedure getConstructor()

Description copied from interface: TypeValue

Get the constructor function for this type. Returns null if there is no contructor function. Also returns null if this extends ClassType or ArrayType and standard Java constructors (<init> methods) should be used.

Specified by:

getConstructor in interface TypeValue

itemCountRange

public static int itemCountRange(Type type)

Return a conservative estimate on the min/max number of items of a type.

Returns:

maxCount << 12 | minCount & 0xFFF, where a maxCount of -1 means unbounded.

itemCountCode

public static char itemCountCode(Type type)

Returna a quantifer kind for a sequence type.

Returns:

'0' if type is known to be a void (0-item) type; '1' if type is known to be a single-item type; '?' if type matches a sequence of 0 or 1 items; '+' if type matches a sequence of 1 or more items; '*' otherwise.

itemCountIsZeroOrOne

public static boolean itemCountIsZeroOrOne(Type type)

itemCountMin

public static int itemCountMin(Type type)

itemCountMax

public static int itemCountMax(Type type)

itemCountIsOne

public static boolean itemCountIsOne(Type type)

compatibleWithCount

public static int compatibleWithCount(Type type,
 int count)

itemPrimeType

public static Type itemPrimeType(Type type)

XQuery formal semantics "prime type"

toString

public String toString()

Overrides:

toString in class Type

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException