Documentation


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.wsdl.model;
21  
22  import java.io.IOException  ;
23  import javax.xml.namespace.QName  ;
24  import org.w3c.dom.Element  ;
25  
26  /**
27   * @author rico
28   * @author Nam Nguyen
29   * Represents the documentation element in a WSDL document
30   */
31  public interface Documentation extends WSDLComponent{
32      public static final String   CONTENT_PROPERTY = "content";
33      
34      /**
35       * @return text representation of the documentation element content.
36       */
37      String   getTextContent();
38      
39      /**
40       * Set the documentation element content to a text node with the given
41       * string value.
42       */
43      void setTextContent(String   content);
44      
45      /**
46       * @return XML fragment text of documentation element content.
47       */
48      String   getContentFragment();
49      
50      /**
51       * Sets the XML fragment text of documentation element content.
52       * The XML fragment will be parsed and the resulting nodes will
53       * replace the current children of this documentation element.
54       * @param text XML fragment text.
55       * @exception IOException if the fragment text is not well-form.
56       */
57      void setContentFragment(String   text) throws IOException  ;
58      
59      /**
60       * @return a mutable clone of the documentation element itself.
61       */
62      Element   getDocumentationElement();
63      
64      /**
65       * Sets the documentation element to the given element.
66       */
67      void setDocumentationElement(Element   documentationElement);
68      
69      /**
70       * Returns string value of the attribute from different namespace.
71       * If given QName has prefix, it will be ignored.
72       * @param attr non-null QName represents the attribute name.
73       * @return attribute value
74       */
75      String   getAnyAttribute(QName   attr);
76  
77      /**
78       * Set string value of the attribute identified by given QName.
79       * This will fire property change event using attribute local name.
80       * @param attr non-null QName represents the attribute name.
81       * @param value string value for the attribute.
82       */
83      void setAnyAttribute(QName   attr, String   value);
84  }
85
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags