uk.co.badgersinfoil.metaas
Interface ASMethod

All Superinterfaces:
ASMember, StatementContainer

public interface ASMethod
extends StatementContainer, ASMember

Represents an ActionScript method definition within an ActionScript class or interface.

See Also:
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
 void addParam(java.lang.String name, java.lang.String type)
          Adds a formal 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 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.
 void setAccessorRole(ASMethod.AccessorRole getter)
          Allows the role of a method to be changed.
 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.StatementContainer
addComment, addStmt, newDoWhile, newFor, newForIn, newIf, newSwitch, newWhile
 
Methods inherited from interface uk.co.badgersinfoil.metaas.ASMember
getDocComment, setDocComment, setName
 

Method Detail

getName

public java.lang.String getName()
Returns the name of this method.

Specified by:
getName in interface ASMember

getArgs

public java.util.List getArgs()
Returns a list of the formal arguments accepted by this ActionScript method. Note that the resulting list is not modifiable.

See Also:
addParam(String, String)

getType

public java.lang.String getType()
Returns the name of the return type of this ActionScript method, or null if it is untyped.

Specified by:
getType in interface ASMember

setType

public void setType(java.lang.String string)
Defines the name of the type of object returned by this ActionScript method. May be set to null, denoting that the return value is untyped.

Specified by:
setType in interface ASMember

getVisibility

public Visibility getVisibility()
Returns a value representing any protection-against-access defined for this ActionScript method.

Specified by:
getVisibility in interface ASMember

setVisibility

public void setVisibility(Visibility visibility)
Defines the level of protection-against-external-access for this ActionScript method.

Specified by:
setVisibility in interface ASMember

isStatic

public boolean isStatic()
Returns true if this ActionScript method is static (i.e. the method definition uses the static keyword).

Specified by:
isStatic in interface ASMember

setStatic

public void setStatic(boolean s)
Defines whether this ActionScript method is static or not.

Specified by:
setStatic in interface ASMember

addParam

public void addParam(java.lang.String name,
                     java.lang.String type)
Adds a formal parameter to the list of parameters supported by this ActionScript method.

Parameters:
name - The name for the parameter
type - The type for the parameter, or null if the parameter is to be untyped

getAccessorRole

public 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.


setAccessorRole

public void setAccessorRole(ASMethod.AccessorRole getter)
Allows the role of a method to be changed.