FieldNode (Groovy 4.0.15)
Description: declaration: package: org.codehaus.groovy.ast, class: FieldNode

Package org.codehaus.groovy.ast

# Class FieldNode

java.lang.Object
org.codehaus.groovy.ast.ASTNode
org.codehaus.groovy.ast.AnnotatedNode
org.codehaus.groovy.ast.FieldNode

All Implemented Interfaces:
  `GroovydocHolder<AnnotatedNode>`, `NodeMetaDataHandler`, `Variable`

public class FieldNode extends AnnotatedNode implements Variable
Represents a field (member variable)

- ## Field Summary

  ### Fields inherited from interface groovy.lang.groovydoc.GroovydocHolder

  `DOC_COMMENT`

- ## Constructor Summary

  Constructors
  Modifier
  Constructor
  Description
  `protected`
  `FieldNode()`
  ``
  `FieldNode(String name, int modifiers, ClassNode type, ClassNode owner, Expression initialValueExpression)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `equals(Object obj)`
  `Expression`
  `getInitialExpression()`
  expression used to initialize the variable or null of there is no initialization.
  `Expression`
  `getInitialValueExpression()`
  `int`
  `getModifiers()`
  `String`
  `getName()`
  the name of the variable
  `ClassNode`
  `getOriginType()`
  the type before wrapping primitives type of the variable
  `ClassNode`
  `getOwner()`
  `ClassNode`
  `getType()`
  the type of the variable
  `boolean`
  `hasInitialExpression()`
  returns true if there is an initialization expression
  `boolean`
  `isClosureSharedVariable()`
  Deprecated.
  `boolean`
  `isDynamicTyped()`
  `boolean`
  `isEnum()`
  `boolean`
  `isFinal()`
  `boolean`
  `isHolder()`
  `boolean`
  `isInStaticContext()`
  returns true if this variable is used in a static context.
  `boolean`
  `isPrivate()`
  `boolean`
  `isProtected()`
  `boolean`
  `isPublic()`
  `boolean`
  `isStatic()`
  `boolean`
  `isVolatile()`
  `static FieldNode`
  `newStatic(Class theClass, String name)`
  `void`
  `rename(String name)`
  `void`
  `setClosureSharedVariable(boolean inClosure)`
  Deprecated.
  `void`
  `setHolder(boolean holder)`
  `void`
  `setInitialValueExpression(Expression initialValueExpression)`
  `void`
  `setModifiers(int modifiers)`
  `void`
  `setOriginType(ClassNode cn)`
  `void`
  `setOwner(ClassNode owner)`
  `void`
  `setType(ClassNode type)`

  ### Methods inherited from class org.codehaus.groovy.ast.AnnotatedNode

  `addAnnotation, addAnnotation, addAnnotations, getAnnotations, getAnnotations, getDeclaringClass, getGroovydoc, getInstance, hasNoRealSourcePosition, isSynthetic, setDeclaringClass, setHasNoRealSourcePosition, setSynthetic`

  ### Methods inherited from class org.codehaus.groovy.ast.ASTNode

  `copyNodeMetaData, getColumnNumber, getLastColumnNumber, getLastLineNumber, getLineNumber, getMetaDataMap, getText, setColumnNumber, setLastColumnNumber, setLastLineNumber, setLineNumber, setMetaDataMap, setSourcePosition, visit`

  ### Methods inherited from class java.lang.Object

  `clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface org.codehaus.groovy.ast.NodeMetaDataHandler

  `copyNodeMetaData, getNodeMetaData, getNodeMetaData, getNodeMetaData, putNodeMetaData, removeNodeMetaData, setNodeMetaData`

- ## Constructor Details

  - ### FieldNode

    protected FieldNode()

  - ### FieldNode

    public FieldNode(String name, int modifiers, ClassNode type, ClassNode owner, Expression initialValueExpression)

- ## Method Details

  - ### newStatic

    public static FieldNode newStatic(Class theClass, String name) throws SecurityException, NoSuchFieldException
    Throws:
      `SecurityException`
      `NoSuchFieldException`

  - ### getInitialExpression

    public Expression getInitialExpression()
    Description copied from interface: `Variable`
    expression used to initialize the variable or null of there is no initialization.
    Specified by:
      `getInitialExpression` in interface `Variable`

  - ### getModifiers

    public int getModifiers()
    Specified by:
      `getModifiers` in interface `Variable`

  - ### getName

    public String getName()
    Description copied from interface: `Variable`
    the name of the variable
    Specified by:
      `getName` in interface `Variable`

  - ### getType

    public ClassNode getType()
    Description copied from interface: `Variable`
    the type of the variable
    Specified by:
      `getType` in interface `Variable`

  - ### setType

    public void setType(ClassNode type)

  - ### getOwner

    public ClassNode getOwner()

  - ### isHolder

    public boolean isHolder()

  - ### setHolder

    public void setHolder(boolean holder)

  - ### isDynamicTyped

    public boolean isDynamicTyped()
    Specified by:
      `isDynamicTyped` in interface `Variable`

  - ### setModifiers

    public void setModifiers(int modifiers)

  - ### isStatic

    public boolean isStatic()
    Returns:
      true if the field is static

  - ### isEnum

    public boolean isEnum()
    Returns:
      true if the field is an enum

  - ### isFinal

    public boolean isFinal()
    Returns:
      true if the field is final

  - ### isVolatile

    public boolean isVolatile()
    Returns:
      true if the field is volatile

  - ### isPublic

    public boolean isPublic()
    Returns:
      true if the field is public

  - ### isProtected

    public boolean isProtected()
    Returns:
      true if the field is protected

  - ### isPrivate

    public boolean isPrivate()
    Returns:
      true if the field is private
    Since:
      2.5.0

  - ### setOwner

    public void setOwner(ClassNode owner)
    Parameters:
      `owner` - The owner to set.

  - ### hasInitialExpression

    public boolean hasInitialExpression()
    Description copied from interface: `Variable`
    returns true if there is an initialization expression
    Specified by:
      `hasInitialExpression` in interface `Variable`

  - ### isInStaticContext

    public boolean isInStaticContext()
    Description copied from interface: `Variable`
    returns true if this variable is used in a static context. A static context is any static initializer block, when this variable is declared as static or when this variable is used in a static method
    Specified by:
      `isInStaticContext` in interface `Variable`

  - ### getInitialValueExpression

    public Expression getInitialValueExpression()

  - ### setInitialValueExpression

    public void setInitialValueExpression(Expression initialValueExpression)

  - ### isClosureSharedVariable

    @Deprecated public boolean isClosureSharedVariable()
    Deprecated.
    Specified by:
      `isClosureSharedVariable` in interface `Variable`

  - ### setClosureSharedVariable

    @Deprecated public void setClosureSharedVariable(boolean inClosure)
    Deprecated.
    Specified by:
      `setClosureSharedVariable` in interface `Variable`

  - ### equals

    public boolean equals(Object obj)
    Overrides:
      `equals` in class `Object`

  - ### getOriginType

    public ClassNode getOriginType()
    Description copied from interface: `Variable`
    the type before wrapping primitives type of the variable
    Specified by:
      `getOriginType` in interface `Variable`

  - ### setOriginType

    public void setOriginType(ClassNode cn)

  - ### rename

    public void rename(String name)