View Javadoc
1   /*
2    * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.tools.internal.xjc.model;
27  
28  import com.sun.tools.internal.xjc.Plugin;
29  import com.sun.xml.internal.xsom.XSComponent;
30  
31  import org.xml.sax.Locator;
32  
33  /**
34   * Implemented by model components that can have customizations contributed by {@link Plugin}s.
35   *
36   * @author Kohsuke Kawaguchi
37   */
38  public interface CCustomizable {
39      /**
40       * Gets the list of customizations attached to this model component.
41       *
42       * @return
43       *      can be an empty list but never be null. The returned list is read-only.
44       *      Do not modify.
45       *
46       * @see Plugin#getCustomizationURIs()
47       */
48      CCustomizations getCustomizations();
49  
50      /**
51       * Gets the source location in the schema from which this model component is created.
52       *
53       * @return never null.
54       */
55      Locator getLocator();
56  
57      /**
58       * If this model object is built from XML Schema,
59       * this property returns a schema component from which the model is built.
60       *
61       * @return
62       *      null if the model is built from sources other than XML Schema
63       *      (such as DTD.)
64       */
65      XSComponent getSchemaComponent();
66  }