|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMethod
Nested Class Summary | |
---|---|
static interface |
IMethod.IArgument
|
static interface |
IMethod.IException
|
static class |
IMethod.OssjEntityMethodFlavor
This enum represents the "Flavors" that might be supported for a method. |
static class |
IMethod.OssjMethodProperty
This enum represents some key "Properties" of a method. |
Field Summary |
---|
Fields inherited from interface org.eclipse.tigerstripe.model.IModelComponent |
---|
VISIBILITY_PACKAGE, VISIBILITY_PRIVATE, VISIBILITY_PROTECTED, VISIBILITY_PUBLIC |
Method Summary | |
---|---|
void |
addIArgument(IMethod.IArgument argument)
|
void |
addIException(IMethod.IException exception)
|
void |
addReturnStereotypeInstance(IStereotypeInstance instance)
|
IMethod |
clone()
|
IAbstractArtifact |
getContainingArtifact()
Returns the IArtifact that is the "container" for the Method. |
java.lang.String |
getDefaultReturnValue()
Returns the default return value for this method is it has been defined, null otherwise |
ISessionArtifact.IEntityMethodFlavorDetails |
getEntityMethodFlavorDetails(IMethod.OssjEntityMethodFlavor flavor)
Returns the OSSJ flavor details for this method |
IMethod.IArgument[] |
getIArguments()
Returns an array of all of the arguments for this Method. |
IMethod.IException[] |
getIExceptions()
Returns an array of all of the exceptions for this Method. |
java.lang.String |
getLabelString()
Returns a String containing the methodName+profile&returntype. |
java.lang.String |
getMethodId()
Returns an identifier that uniquely identifies this method within the scope of its artifact. |
java.lang.String |
getMethodReturnName()
Returns the name of the return for this method. |
java.util.Properties |
getOssjMethodProperties()
Deprecated. Do not use. Use getEntityMethodFlavorDetails instead. |
IType |
getReturnIType()
Returns the return type for this Method. |
int |
getReturnRefBy()
Returns an integer value indicating the reference type of the return. |
java.lang.String |
getReturnRefByString()
Returns an String value indicating the reference type of the return. |
IStereotypeInstance[] |
getReturnStereotypeInstances()
Returns all the stereotype instances for this |
boolean |
isAbstract()
Returns a boolean indicating whether this method is abstract or not. |
boolean |
isInstanceMethod()
Returns true if this Method is an instance method. |
boolean |
isIteratorReturn()
Returns a boolean indicating whether the return for this method is an iterator or not. |
boolean |
isOptional()
Returns a boolean indicating if this Method is optional or mandatory. |
boolean |
isOrdered()
Returns true if the return of this method contains ordered values (multiplicity > 1) |
boolean |
isUnique()
Returns true if the return of this method contains unique values (multiplicity > 1) |
boolean |
isVoid()
Returns true if the return of this Method is void. |
ISessionArtifact.IEntityMethodFlavorDetails |
makeEntityMethodFlavorDetails()
Factory method for OSSJ Entity Details. |
IMethod.IArgument |
makeIArgument()
|
IMethod.IException |
makeIException()
|
IType |
makeIType()
Factory method for IType |
void |
removeIArguments(IMethod.IArgument[] arguments)
|
void |
removeIExceptions(IMethod.IException[] exception)
|
void |
removeReturnStereotypeInstance(IStereotypeInstance instance)
|
void |
removeReturnStereotypeInstances(IStereotypeInstance[] instances)
|
void |
setAbstract(boolean isAbstract)
sets whether this method is abstract or not |
void |
setDefaultReturnValue(java.lang.String defaultReturnValue)
|
void |
setEntityMethodFlavorDetails(IMethod.OssjEntityMethodFlavor flavor,
ISessionArtifact.IEntityMethodFlavorDetails details)
Sets the OSSJ Entity flavor details for this method. |
void |
setIArguments(IMethod.IArgument[] arguments)
|
void |
setIExceptions(IMethod.IException[] exceptions)
|
void |
setInstanceMethod(boolean instance)
Sets the "InstanceMethod" flag. |
void |
setIteratorReturn(boolean iterate)
|
void |
setMethodReturnName(java.lang.String methodReturnName)
Sets the name of the return for this method. |
void |
setOptional(boolean optional)
|
void |
setOrdered(boolean isOrdered)
|
void |
setOssjMethodProperties(java.util.Properties prop)
Deprecated. DO NOT USE. Please use setOssjEntityMethodFlavorDetails instead. |
void |
setReturnIType(IType returnType)
Sets the return type for this Method. |
void |
setReturnRefBy(int refBy)
|
void |
setUnique(boolean isUnique)
|
void |
setVoid(boolean isVoid)
Sets the return type to void |
java.util.List<org.eclipse.tigerstripe.internal.api.utils.TigerstripeError> |
validate()
|
Methods inherited from interface org.eclipse.tigerstripe.model.IModelComponent |
---|
addStereotypeInstance, getComment, getName, getVisibility, isInActiveFacet, removeStereotypeInstance, removeStereotypeInstances, setComment, setName, setVisibility |
Methods inherited from interface org.eclipse.tigerstripe.profile.stereotype.IStereotypeCapable |
---|
getStereotypeInstances |
Method Detail |
---|
IMethod.IException makeIException()
void setIExceptions(IMethod.IException[] exceptions)
void addIException(IMethod.IException exception)
void removeIExceptions(IMethod.IException[] exception)
void setVoid(boolean isVoid)
void setIteratorReturn(boolean iterate)
IType makeIType()
java.lang.String getLabelString()
void setReturnRefBy(int refBy)
void setReturnIType(IType returnType)
returnType
- -
the return type for this method.IMethod.IArgument makeIArgument()
void setIArguments(IMethod.IArgument[] arguments)
void addIArgument(IMethod.IArgument argument)
void removeIArguments(IMethod.IArgument[] arguments)
void setOptional(boolean optional)
@Deprecated void setOssjMethodProperties(java.util.Properties prop)
prop
- -
the internal representation for the flavor details.void setInstanceMethod(boolean instance)
instance
- java.util.List<org.eclipse.tigerstripe.internal.api.utils.TigerstripeError> validate()
ISessionArtifact.IEntityMethodFlavorDetails getEntityMethodFlavorDetails(IMethod.OssjEntityMethodFlavor flavor) throws TigerstripeException
flavor
- -
OssjEntityMethodFlavor target flavor
TigerstripeException,
- if method doesn't belong to Managed Entity
TigerstripeException
ISessionArtifact.IEntityMethodFlavorDetails makeEntityMethodFlavorDetails()
void setEntityMethodFlavorDetails(IMethod.OssjEntityMethodFlavor flavor, ISessionArtifact.IEntityMethodFlavorDetails details) throws TigerstripeException
flavor
- -
the target flavordetails
- -
the details for this target flavor
TigerstripeException
- -
if this method doesn't belong to a ManagedEntity@Deprecated java.util.Properties getOssjMethodProperties()
void setUnique(boolean isUnique)
void setOrdered(boolean isOrdered)
boolean isAbstract()
void setAbstract(boolean isAbstract)
isAbstract
- -
boolean, true to set this method as abstractvoid setDefaultReturnValue(java.lang.String defaultReturnValue)
void setMethodReturnName(java.lang.String methodReturnName)
IStereotypeInstance[] getReturnStereotypeInstances()
void addReturnStereotypeInstance(IStereotypeInstance instance)
void removeReturnStereotypeInstance(IStereotypeInstance instance)
void removeReturnStereotypeInstances(IStereotypeInstance[] instances)
IMethod clone()
IAbstractArtifact getContainingArtifact()
java.lang.String getDefaultReturnValue()
IMethod.IArgument[] getIArguments()
IMethod.IException[] getIExceptions()
java.lang.String getMethodId()
java.lang.String getMethodReturnName()
IType getReturnIType()
int getReturnRefBy()
java.lang.String getReturnRefByString()
boolean isInstanceMethod()
boolean isIteratorReturn()
boolean isOptional()
boolean isOrdered()
boolean isUnique()
boolean isVoid()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |