DDBeanRoot


1   
2   /*
3    * The contents of this file are subject to the terms 
4    * of the Common Development and Distribution License 
5    * (the License).  You may not use this file except in
6    * compliance with the License.
7    * 
8    * You can obtain a copy of the license at 
9    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
10   * glassfish/bootstrap/legal/CDDLv1.0.txt.
11   * See the License for the specific language governing 
12   * permissions and limitations under the License.
13   * 
14   * When distributing Covered Code, include this CDDL 
15   * Header Notice in each file and include the License file 
16   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
17   * If applicable, add the following below the CDDL Header, 
18   * with the fields enclosed by brackets [] replaced by
19   * you own identifying information: 
20   * "Portions Copyrighted [year] [name of copyright owner]"
21   * 
22   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
23   */
24  
25  package javax.enterprise.deploy.model;
26  
27  import javax.enterprise.deploy.shared.ModuleType  ;
28  
29  /**
30   * An interface that represents the root of a standard deployment 
31   * descriptor.  A DDBeanRoot is a type of DDBean.
32   *
33   * @author gfink
34   */
35  public interface DDBeanRoot extends DDBean   {
36      
37      /**
38       * Return the ModuleType of deployment descriptor.
39       *
40       * @return The ModuleType of deployment descriptor
41       */   
42     public ModuleType   getType();
43     
44     /**
45      * Return the containing DeployableObject
46      * @return The DeployableObject that contains this
47      *           deployment descriptor
48      */   
49     public DeployableObject   getDeployableObject();
50     
51     /**
52      * A convenience method to return the DTD version number.
53      * The DeployableObject has this information.
54      * @return a string containing the DTD version number
55      *
56      * This method is being deprecated. Two DD data formats
57      * are being used, DTD and XML Schema.  DDBeanRoot.getDDBeanRootVersion
58      * should be used in its place.
59      *
60      * @deprecated As of version 1.1 replaced by 
61      * DDBeanRoot.getDDBeanRootVersion()
62      */
63     public String   getModuleDTDVersion();
64  
65     /** 
66      * Returns the version number of an XML instance document.
67      * This method is replacing the methods DDBeanRoot.getModuleDTDVersion 
68      * and DeployableObject.getModuleDTDVersion. This method returns 
69      * the version number of any J2EE XML instance document. 
70      *
71      * @return a string that is the version number of the XML instance 
72      *   document. Null is returned if no version number can be found. 
73      */ 
74     public String   getDDBeanRootVersion(); 
75  
76      /**
77       * Return the XPath for this standard bean.
78       * The root XPath is "/".
79       * @return "/" this is the root standard bean.
80       */
81      public String   getXpath();
82  
83      /**
84       * Returns the filename relative to the root of the module 
85       * of the XML instance document this DDBeanRoot represents. 
86       *
87       * @return String the filename relative to the root of the module 
88       */ 
89     public String   getFilename(); 
90  }
91  
92
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags