org.eclipse.tigerstripe.workbench.model.deprecated_
Interface IType

public interface IType

A Type in a Tigerstripe Model

Author:

Eric Dillon

Field Summary

static int	MULTIPLICITY_MULTI Deprecated. no use of Multiplicity any more, please use Type Multiplicity
static int	MULTIPLICITY_SINGLE Deprecated. no use of Multiplicity any more, please use Type Multiplicity

Method Summary

IType	clone() Clone this type.
java.lang.String	defaultValue() Returns a simple default value.
IAbstractArtifact	getArtifact() Get the Tigerstripe artifact (of any type).
java.lang.String	getFullyQualifiedName() Returns the fully qualified name (ie.
int	getMultiplicity() Deprecated. since 2.2-rc, no use of multiplicity anymore, TypeMultiplicity instead
java.lang.String	getName() Returns the name of this type.
java.lang.String	getPackage() Returns the package name for this type.
IModelComponent.EMultiplicity	getTypeMultiplicity() Returns the multiplicity for this type.
boolean	isArtifact() Test to see of the type represented here is a Tigerstripe artifact (of any type).
boolean	isDatatype() Test to see of the type represented here is a Tigerstripe Datatype artifact.
boolean	isEntityType() Test to see of the type represented here is a Tigerstripe ManagedEntity artifact.
boolean	isEnum() Test to see of the type represented here is a Tigerstripe Enumeration artifact.
boolean	isPrimitive() Test to see of the type represented here is a "primitive" type.
void	setFullyQualifiedName(java.lang.String fqn) Sets the fully qualified name (ie.
void	setMultiplicity(int multiplicity) Deprecated. since 2.2-rc, no use of multiplicity anymore, TypeMultiplicity instead
void	setTypeMultiplicity(IModelComponent.EMultiplicity multiplicity) Sets the multiplicity for this type.
IStatus	validate()
IStatus	validate(boolean isMethodReturnCheck)

Field Detail

MULTIPLICITY_MULTI

@Deprecated
static final int MULTIPLICITY_MULTI

Deprecated. no use of Multiplicity any more, please use Type Multiplicity

Static integer value for multiple multiplicity - ie "*"

See Also:

Constant Field Values

MULTIPLICITY_SINGLE

@Deprecated
static final int MULTIPLICITY_SINGLE

Deprecated. no use of Multiplicity any more, please use Type Multiplicity

Static integer value for single multiplicity - ie "0..1"

See Also:

Constant Field Values

Method Detail

getFullyQualifiedName

java.lang.String getFullyQualifiedName()

Returns the fully qualified name (ie. package + name) of this type.

Returns:

String - the FQN of the type.

setFullyQualifiedName

void setFullyQualifiedName(java.lang.String fqn)

Sets the fully qualified name (ie. package + name) of this type. The string should be '.' separated.

Parameters:

fqn -

getTypeMultiplicity

IModelComponent.EMultiplicity getTypeMultiplicity()

Returns the multiplicity for this type.

Returns:

Since:

2.2-rc

setTypeMultiplicity

void setTypeMultiplicity(IModelComponent.EMultiplicity multiplicity)

Sets the multiplicity for this type.

Parameters:

multiplicity -

validate

IStatus validate()

validate

IStatus validate(boolean isMethodReturnCheck)

clone

IType clone()

Clone this type.

Returns:

defaultValue

java.lang.String defaultValue()

Returns a simple default value. For a type with FQN of "java.lang.String" this will return "Value". For a type with FQN of "int" this will return "0".

Returns:

String representation of a default Value

getArtifact

IAbstractArtifact getArtifact()

Get the Tigerstripe artifact (of any type).

Returns:

the Artifact if the FQN of this type matches that of a artifact in the same project(including dependencies & refereneces), null otherwise.

getName

java.lang.String getName()

Returns the name of this type.

Returns:

String - the name of the type.

getPackage

java.lang.String getPackage()

Returns the package name for this type.

Returns:

String - the package where this artifact was defined.

isArtifact

boolean isArtifact()

Test to see of the type represented here is a Tigerstripe artifact (of any type).

Returns:

true if the FQN of this type matches that of a artifact in the same project(including dependencies & refereneces).

isDatatype

boolean isDatatype()

Test to see of the type represented here is a Tigerstripe Datatype artifact.

Returns:

true if the FQN of this type matches that of a Datatype artifact in the same project(including dependencies & refereneces).

isEntityType

boolean isEntityType()

Test to see of the type represented here is a Tigerstripe ManagedEntity artifact.

Returns:

true if the FQN of this type matches that of a ManagedEntity artifact in the same project(including dependencies & refereneces).

isEnum

boolean isEnum()

Test to see of the type represented here is a Tigerstripe Enumeration artifact.

Returns:

true if the FQN of this type matches that of a Enumeration artifact in the same project(including dependencies & refereneces).

isPrimitive

boolean isPrimitive()

Test to see of the type represented here is a "primitive" type. Note that the primitive test here is *not* for primitive types defined in a profile, but for java primitive types: boolean,int,char,float,double,long,short,byte

Returns:

true if the FQN of the type patches any of those in this list.

getMultiplicity

@Deprecated
int getMultiplicity()

Deprecated. since 2.2-rc, no use of multiplicity anymore, TypeMultiplicity instead

Returns an integer value indicating the multiplicity of this type. Possible values are defined in the static fields of this class.

Returns:

int - the integer value corresponding to the multiplicity.

setMultiplicity

@Deprecated
void setMultiplicity(int multiplicity)

Deprecated. since 2.2-rc, no use of multiplicity anymore, TypeMultiplicity instead

Parameters:

multiplicity -