org.apache.xmlbeans.impl.jam.JAnnotatedElement 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!

package org.apache.xmlbeans.impl.jam;

/**
 * Base abstraction for JElements which can carry annotations and comments.
 * The only JElements which cannot do this are JAnnotation and JComment.
 *
 * @author Patrick Calahan <email: pcal-at-bea-dot-com>
 */
public abstract interface JAnnotatedElement extends JElement {

  // ========================================================================
  // Public methods

  /**
   * Returns the metadata JAnnotations that are associated with
   * this abstraction.  Returns an empty array if there are no
   * annotations.
   */
  public JAnnotation[] getAnnotations();

  /**
   * Returns the JAnnotation which is being proxied by the given subclass
   * of TypedAnnotationProxyBase, or null if no such annotation exists.  If it
   * does exist, the getProxy() method on the returned
   * object is guaranteed to return be an instance of the proxyClass.
   *
   * @throws IllegalArgumentException if the proxyClass parameter is null
   * or not a subclass of TypedAnnotationProxyBase.
   */
  public JAnnotation getAnnotation(Class proxyClass);

  /**
   * Returns an instance of TypedAnnotationProxyBase on this elements for which the given
   * proxy class has been established.  This method is guaranteed to
   * return either an instance of the given proxyClass or null.
   *
   * This method is simply a convenient shorthand for
   * getAnnotation(proxyClass).getProxy().
   *
   * @throws IllegalArgumentException if the proxyClass parameter is null
   * or not a subclass of AnnotationProxy.
   */
  /**
   * @deprecated
   */ 
  public Object getAnnotationProxy(Class proxyClass);

  /**
   * Returns the annotation that represents the named 175 annotation
   * or javadoc tag on this elements.
   */
  public JAnnotation getAnnotation(String tagnameProxynameOr175typename);


  /**
   * Shortcut method which returns a given annotation value.  The 'valueId'
   * should be a string of the format 'annotation-name@value-name'.  The
   * value-name may be ommitted; if it is, it defaults to
   * JAnntoation.SINGLE_MEMBER_VALUE.
   *
   * @param valueId
   * @return
   */
  public JAnnotationValue getAnnotationValue(String valueId);

  /**
   * Returns the comment associated with this abstraction.
   * Returns null if it has no comment.
   */
  public JComment getComment();

  //expose these soon, remove getAllJavadocTags

  //public JAnnotation[] getLiteralAnnotations();

  //public JAnnotation[] getLiteralAnnotations(String annotationName);

  /**
   * @deprecated
   */
  public JAnnotation[] getAllJavadocTags();


}