| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * |
| * Copyright (c) 2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache |
| * XMLBeans", nor may "Apache" appear in their name, without prior |
| * written permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation and was |
| * originally based on software copyright (c) 2003 BEA Systems |
| * Inc., <http://www.bea.com/>. For more information on the Apache Software |
| * Foundation, please see <http://www.apache.org/>. |
| */ |
| |
| package org.apache.xmlbeans.impl.jam; |
| |
| /** |
| * <p>Represents a metadata that is associated with a particular |
| * JElement. Note that JAnnoations are JElements, which means |
| * that they themselves can have annotations, and can be treated as |
| * nodes in a JAM hierarchy.</p> |
| * |
| * <p>Annotations can be simple or complex. Values of simple |
| * annotations can be retrieved via the various get...Value() methods. |
| * Complex attributes can be navigated via the getAnnotations() method |
| * which exposes nested attributes (which may in turn be either simple |
| * or complex.</p> |
| * |
| * @author Patrick Calahan <pcal@bea.com> |
| */ |
| public interface JAnnotation extends JElement { |
| |
| /** |
| * Returns the name of this annotation. Note that in the case of |
| * javadoc-style annotations, this name will NOT include the leading |
| * '@'. |
| */ |
| public String getName(); |
| |
| /** |
| * Returns the String value of the annotation. Returns an empty string |
| * by default. |
| */ |
| public String getStringValue(); |
| |
| /** |
| * Returns the value as an int. Returns 0 by default if the value |
| * cannot be understood as an int. |
| */ |
| public int getIntValue(); |
| |
| /** |
| * Returns the value as a boolean. Returns false by default if the |
| * annotation value cannot be understood as a boolean. |
| */ |
| public boolean getBooleanValue(); |
| |
| /** |
| * Returns the value as a long. Returns 0 by default if the |
| * annotation value cannot be understood as a long. |
| */ |
| public long getLongValue(); |
| |
| /** |
| * Returns the value as a short. Returns 0 by default if the |
| * annotation value cannot be understood as a short. |
| */ |
| public short getShortValue(); |
| |
| /** |
| * Returns the value as a double. Returns 0 by default if the |
| * annotation value cannot be understood as a double. |
| */ |
| public double getDoubleValue(); |
| |
| /** |
| * Returns the value as a byte. Returns 0 by default if the |
| * annotation value cannot be understood as a byte. |
| */ |
| public byte getByteValue(); |
| } |