Annotation


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8   
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.xml.schema.model;
21  
22  import java.util.Collection  ;
23  
24  /**
25   * Represents the schema annotation component, <xs:annotation>.
26   * An example:
27   *    <xs:annotation>
28   *       <xs:documentation>A type for experts only</xs:documentation>
29   *       <xs:appinfo>
30   *         <fn:specialHandling>checkForPrimes</fn:specialHandling>
31   *       </xs:appinfo>
32   *    </xs:annotation>
33   * See http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/structures.html#cAnnotations.
34   *
35  **/
36  public interface Annotation extends SchemaComponent {
37      
38      public static final String   DOCUMENTATION_PROPERTY = "documentation";
39      public static final String   APPINFO_PROPERTY = "appinfo";
40          
41      /**
42       * Adds the given Documentation to this Annotation
43       * @param documentation the documentation to add to this Annotation
44      **/
45      public void addDocumentation(Documentation documentation);
46  
47      /**
48       * Removes the given Documentation from this Annotation
49       * @param documentation the Documentation to remove
50      **/
51      public void removeDocumentation(Documentation documentation);
52      
53      /**
54       * Returns an enumeration of all documentation elements for this Annotation
55       * @return an enumeration of all documentation elements for this Annotation
56      **/
57      public Collection  <Documentation> getDocumentationElements();
58      
59      Collection  <AppInfo> getAppInfos();
60      void addAppInfo(AppInfo appInfo);
61      void removeAppInfo(AppInfo appInfo);
62      
63  } //-- Annotation
64
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags