java.lang.Object
org.codehaus.modello.plugin.java.javasource.JField

public class JField extends Object
A class which holds information about a field. Modelled closely after the Java Reflection API. This class is part of package which is used to create source code in memory.
Version:
$Revision$ $Date$
Author:
Keith Visco
  • Constructor Details

  • Method Details

    • getComment

      public JDocComment getComment()
      Returns the comment describing this member.
      Returns:
      the comment describing this member, or null if no comment has been set.
    • getDeclaringClass

      public JClass getDeclaringClass()
      Returns the class in which this JField has been declared
      Returns:
      the class in which this JField has been declared
    • getInitString

      public String getInitString()
      Returns the initialization String for this JField
      Returns:
      the initialization String for this JField, or null if no initialization String was specified.
    • getModifiers

      public JModifiers getModifiers()
      Returns the modifiers for this JField
      Returns:
      the modifiers for this JField
    • getName

      public String getName()
      Returns the name of this JField
      Returns:
      the name of this JField
    • getType

      public JType getType()
      Returns the JType represting the type of this JField
      Returns:
      the JClass represting the type of this JField
    • setComment

      public void setComment(JDocComment comment)
      Sets the comment describing this member.
      Parameters:
      comment - the JDocComment for this member
    • setComment

      public void setComment(String comment)
      Sets the comment describing this member.
      Parameters:
      comment - the JDocComment for this member
    • setInitString

      public void setInitString(String init)
      Sets the initialization string for this JField; Allows some flexibility in declaring default values.
      Parameters:
      init - the initialization string for this member.
    • setName

      public void setName(String name) throws IllegalArgumentException
      Sets the name of this JField
      Parameters:
      name - the name of this JField
      Throws:
      IllegalArgumentException - when the name is not a valid Java member name, or if a member with the given name already exists in the declaring class
    • setModifiers

      public void setModifiers(JModifiers modifiers)
    • setDeclaringClass

      protected void setDeclaringClass(JClass declaringClass)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getAnnotations

      public JAnnotations getAnnotations()
      Returns:
      the annotations
    • appendAnnotation

      public void appendAnnotation(String annotation)
      Parameters:
      annotation - the annotation to append
    • setAnnotations

      public void setAnnotations(JAnnotations annotations)
      Parameters:
      annotations - the annotations to set