org.apache.xmlbeans.impl.jam.annotation.AnnotationProxy 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.annotation;

import org.apache.xmlbeans.impl.jam.JAnnotationValue;
import org.apache.xmlbeans.impl.jam.JClass;
import org.apache.xmlbeans.impl.jam.provider.JamLogger;
import org.apache.xmlbeans.impl.jam.provider.JamServiceContext;

/**
 * Provides a proxied view of some annotation artifact.  JAM calls the
 * public methods on this class to initialize the proxy with annotation
 * values; those methods should not be called by user code.
 *
 * @author Patrick Calahan <email: pcal-at-bea-dot-com>
 */
/**
 * @deprecated do not use, moving into internal
 */
public abstract class AnnotationProxy {

  // ========================================================================
  // Constants

  /**
   * Name of the member of annotations which have only a single member.
   * As specified in JSR175, that name is "value", but you should use
   * this constant to prevent typos.
   */
  public static final String SINGLE_MEMBER_NAME = "value";


  /**
   * The delimiters to use by default when parsing out name=value pairs
   * from a javadoc tag.
   */
  private static final String DEFAULT_NVPAIR_DELIMS = "\n\r";

  // ========================================================================
  // Variables

  protected JamServiceContext mContext;

  // ========================================================================
  // Initialization methods - called by JAM, don't implement

  /**
   * Called by JAM to initialize the proxy.  Do not try to call this
   * yourself.
   */
  public void init(JamServiceContext ctx) {
    if (ctx == null) throw new IllegalArgumentException("null logger");
    mContext = ctx;
  }

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

  /**
   * Called by JAM to initialize a named member on this annotation proxy.
   * 
   */
  public abstract void setValue(String name, Object value, JClass type);

  //docme
  public abstract JAnnotationValue[] getValues();


  //docme
  public JAnnotationValue getValue(String named) {
    if (named == null) throw new IllegalArgumentException("null name");
    //FIXME this impl is very gross
    named = named.trim();
    JAnnotationValue[] values = getValues();
    for(int i=0; iReturns an instance of JamLogger that this AnnotationProxy should use
   * for logging debug and error messages.
   */
  protected JamLogger getLogger() { return mContext.getLogger(); }

}