|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ASMethod
Represents an ActionScript method definition within an ActionScript class or interface.
ASType.newMethod(String, Visibility, String)
Nested Class Summary | |
---|---|
static class |
ASMethod.AccessorRole
Constants defined by this class denote whether a method is actually an acessor 'get' or 'set' function. |
Method Summary | |
---|---|
ASArg |
addParam(java.lang.String name,
java.lang.String type)
Adds a formal parameter to the list of parameters supported by this ActionScript method. |
ASArg |
addRestParam(java.lang.String name)
Adds a 'rest' parameter to the list of parameters supported by this ActionScript method. |
ASMethod.AccessorRole |
getAccessorRole()
Returns on of ASMethod.AccessorRole.NORMAL_METHOD ,
ASMethod.AccessorRole.GETTER or ASMethod.AccessorRole.SETTER , with
NORMAL_METHOD being the default for newly synthesized methods. |
java.util.List |
getArgs()
Returns a list of the formal arguments accepted by this ActionScript method. |
java.lang.String |
getName()
Returns the name of this method. |
java.lang.String |
getReturnDescriptionString()
Returns any description of the return value from this methods documentation comment. |
java.lang.String |
getType()
Returns the name of the return type of this ActionScript method, or null if it is untyped. |
Visibility |
getVisibility()
Returns a value representing any protection-against-access defined for this ActionScript method. |
boolean |
isStatic()
Returns true if this ActionScript method is static (i.e. |
ASArg |
removeParam(java.lang.String string)
Removes the named parameter from this ActionScript methods formal parameter list. |
void |
setAccessorRole(ASMethod.AccessorRole getter)
Allows the role of a method to be changed. |
void |
setReturnDescription(java.lang.String description)
Shortcut method to update the @return
tagged paragraph in this method's documentation comment, or create
one if it doesn't exist. |
void |
setStatic(boolean s)
Defines whether this ActionScript method is static or not. |
void |
setType(java.lang.String string)
Defines the name of the type of object returned by this ActionScript method. |
void |
setVisibility(Visibility visibility)
Defines the level of protection-against-external-access for this ActionScript method. |
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.StatementContainer |
---|
addComment, addStmt, containsCode, getStatementList, newDeclaration, newDoWhile, newExprStmt, newFor, newForEachIn, newForIn, newIf, newReturn, newSwitch, newWhile, newWith |
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.ASMember |
---|
setName |
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.MetaTagable |
---|
getAllMetaTags, getFirstMetatag, getMetaTagsWithName, newMetaTag |
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.Documentable |
---|
getDescriptionString, getDocComment, getDocumentation, setDescription, setDocComment |
Method Detail |
---|
java.lang.String getName()
getName
in interface ASMember
java.util.List getArgs()
addParam(String, String)
java.lang.String getType()
getType
in interface ASMember
void setType(java.lang.String string)
setType
in interface ASMember
Visibility getVisibility()
getVisibility
in interface ASMember
void setVisibility(Visibility visibility)
setVisibility
in interface ASMember
boolean isStatic()
static
keyword).
isStatic
in interface ASMember
void setStatic(boolean s)
setStatic
in interface ASMember
ASArg addParam(java.lang.String name, java.lang.String type)
name
- The name for the parametertype
- The type for the parameter, or null if the parameter is
to be untyped
addRestParam(String)
ASArg addRestParam(java.lang.String name)
e.g. The java code,
ASMethod meth = class.newMethod("test", Visibility.PUBLIC, "void"); meth.addRestParam("foo");
will result in ActionScript code like,
public function test(...foo):void { }
To create an anonymous 'rest' parameter, pass the name "..." (this name can also be passed to removeParam() to remove an anonymous rest parameter).
#addParam(String)
ASArg removeParam(java.lang.String string)
ASMethod.AccessorRole getAccessorRole()
ASMethod.AccessorRole.NORMAL_METHOD
,
ASMethod.AccessorRole.GETTER
or ASMethod.AccessorRole.SETTER
, with
NORMAL_METHOD being the default for newly synthesized methods.
void setAccessorRole(ASMethod.AccessorRole getter)
void setReturnDescription(java.lang.String description)
@return
tagged paragraph in this method's documentation comment, or create
one if it doesn't exist.
java.lang.String getReturnDescriptionString()
@return
tagged paragraph, this method will return null.
DocComment
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |