uk.co.badgersinfoil.metaas.dom
Interface ASMethod

All Superinterfaces:
ASMember, Documentable, FunctionCommon, MetaTagable, ScriptElement, StatementContainer

public interface ASMethod
extends FunctionCommon, StatementContainer, ASMember

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 accessor 'get' or 'set' function.
 
Method Summary
 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 synthesised methods.
 java.lang.String getReturnDescriptionString()
          Returns any description of the return value from this methods documentation comment.
 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 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 setVisibility(Visibility visibility)
          Defines the level of protection-against-external-access for this ActionScript method.
 
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.FunctionCommon
addParam, addRestParam, getArgs, getType, removeParam, setType
 
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.StatementContainer
addComment, addStmt, containsCode, getStatementList, newBreak, newContinue, newDeclaration, newDeclaration, newDefaultXMLNamespace, newDoWhile, newDoWhile, newExprStmt, newExprStmt, newFor, newFor, newForEachIn, newForEachIn, newForIn, newForIn, newIf, newIf, newReturn, newReturn, newReturn, newSuper, newSwitch, newSwitch, newThrow, newTryCatch, newTryFinally, newWhile, newWhile, newWith, newWith
 
Methods inherited from interface uk.co.badgersinfoil.metaas.dom.ASMember
getName, getType, setName, setType
 
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

getVisibility

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

Specified by:
getVisibility in interface ASMember

setVisibility

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

Specified by:
setVisibility in interface ASMember

isStatic

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

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

Specified by:
setStatic in interface ASMember

getAccessorRole

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 synthesised methods.


setAccessorRole

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


setReturnDescription

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.


getReturnDescriptionString

java.lang.String getReturnDescriptionString()
Returns any description of the return value from this methods documentation comment. If there is no doc-comment, or if the documentation does not contain a @return tagged paragraph, this method will return null.

See Also:
DocComment


Copyright © 2006-2008 David Holroyd. All Rights Reserved.