01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.tools.xjc.model;
38:
39: import com.sun.tools.xjc.Plugin;
40: import com.sun.xml.xsom.XSComponent;
41:
42: import org.xml.sax.Locator;
43:
44: /**
45: * Implemented by model components that can have customizations contributed by {@link Plugin}s.
46: *
47: * @author Kohsuke Kawaguchi
48: */
49: public interface CCustomizable {
50: /**
51: * Gets the list of customizations attached to this model component.
52: *
53: * @return
54: * can be an empty list but never be null. The returned list is read-only.
55: * Do not modify.
56: *
57: * @see Plugin#getCustomizationURIs()
58: */
59: CCustomizations getCustomizations();
60:
61: /**
62: * Gets the source location in the schema from which this model component is created.
63: *
64: * @return never null.
65: */
66: Locator getLocator();
67:
68: /**
69: * If this model object is built from XML Schema,
70: * this property returns a schema component from which the model is built.
71: *
72: * @return
73: * null if the model is built from sources other than XML Schema
74: * (such as DTD.)
75: */
76: XSComponent getSchemaComponent();
77: }
|