KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > ws > jaxme > xs > XSDocumentation


1 /*
2  * Copyright 2003, 2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15
16  */
17 package org.apache.ws.jaxme.xs;
18
19 import org.apache.ws.jaxme.xs.xml.XmlLang;
20 import org.apache.ws.jaxme.xs.xml.XsAnyURI;
21
22 /**
23  * @author <a HREF="mailto:joe@ispsoft.de">Jochen Wiedmann</a>
24  */
25 public interface XSDocumentation extends XSObject {
26   /** <p>Returns the documentations xml:lang attribute or null,
27    * if no such attribute is defined.</p>
28    */
29   public XmlLang getLanguage();
30
31   /** <p>Returns the documentations source element or null,
32    * if no such attribute is defined.</p>
33    */
34   public XsAnyURI getSource();
35
36   /** <p>Returns the documentations content. The objects in the
37    * array are either of:
38    * <ul>
39    * <li>A String, indicating character data, or</li>
40    * <li>A DOM document containing a single child element.</li>
41    * </ul>
42    * @see #getText()
43    */
44   public Object JavaDoc[] getChilds();
45
46   /** <p>Merges the String elements returned by {@link #getChilds()}
47    * into a single String.</p>
48    * @see #getChilds()
49    */
50   public String JavaDoc getText();
51 }
52
Popular Tags