org.apache.xmlbeans.impl.jam.JField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-xmlbeans Show documentation

The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.

The newest version!

/*   Copyright 2004 The Apache Software Foundation
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.apache.xmlbeans.impl.jam;



/**
 * Represents an exposed field on a Java class.
 *
 * @author Patrick Calahan <email: pcal-at-bea-dot-com>
 */
public interface JField extends JMember {

  /**
   * Returns the type of this field.
   */
  public JClass getType();

  /**
   * Return true if this field is final.
   */
  public boolean isFinal();

  /**
   * Return true if this field is static.
   */
  public boolean isStatic();

  /**
   * Return true if this field is volatile.
   */
  public boolean isVolatile();

  /**
   * Return true if this field is transient.
   */
  public boolean isTransient();


  /**
   * Returns a qualied name for this method as specified by
   * java.lang.reflect.Field.toString():
   *
   * Returns a string describing this Field. The format is the access
   * modifiers for the field, if any, followed by the field type, followed
   * by a space, followed by the fully-qualified name of the class declaring
   * the field, followed by a period, followed by the name of the field.
   * For example:
   *
   * public static final int java.lang.Thread.MIN_PRIORITY
   * private int java.io.FileDescriptor.fd
   *
   * The modifiers are placed in canonical order as specified by "The
   * Java Language Specification". This is public, protected or private
   * first, and then other modifiers in the following order: static, final,
   * transient, volatile.
   */
  public String getQualifiedName();
}