Class JField

  • All Implemented Interfaces:
    JMember

    public class JField
    extends java.lang.Object
    implements JMember
    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$
    • Field Detail

      • modifiers

        private JModifiers modifiers
        The set of modifiers for this JField
      • type

        private JType type
      • name

        private java.lang.String name
      • initString

        private java.lang.String initString
      • declaringClass

        private JClass declaringClass
        The Class in this JField has been declared
    • Constructor Detail

      • JField

        public JField​(JType type,
                      java.lang.String name)
    • Method Detail

      • 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 java.lang.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
        Specified by:
        getModifiers in interface JMember
        Returns:
        the modifiers for this JField
      • getName

        public java.lang.String getName()
        Returns the name of this JField
        Specified by:
        getName in interface JMember
        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​(java.lang.String comment)
        Sets the comment describing this member.
        Parameters:
        comment - the JDocComment for this member
      • setInitString

        public void setInitString​(java.lang.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​(java.lang.String name)
                     throws java.lang.IllegalArgumentException
        Sets the name of this JField
        Parameters:
        name - the name of this JField
        Throws:
        java.lang.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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • appendAnnotation

        public void appendAnnotation​(java.lang.String annotation)
        Parameters:
        annotation - the annotation to append
      • setAnnotations

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