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  
30  import org.w3c.dom.Element;
31  import org.xml.sax.Locator;
32  
33  /**
34   * Vendor extension customization contributed from {@link Plugin}s.
35   *
36   * @author Kohsuke Kawaguchi
37   */
38  public class CPluginCustomization {
39      /**
40       * The annotation found in a schema (or in an external binding file.)
41       *
42       * Always non-null.
43       */
44      public final Element element;
45  
46      /**
47       * The source location where this customization is placed.
48       *
49       * <p>
50       * When an error is found in this customization, this information
51       * should be used to point the user to the source of the problem.
52       *
53       * Always non-nul.
54       */
55      public final Locator locator;
56  
57      private boolean acknowledged;
58  
59      /**
60       * When a {@link Plugin} "uses" this annotation, call this method
61       * to mark it.
62       *
63       * <p>
64       * {@link CPluginCustomization}s that are not marked will be
65       * reporeted as an error to users. This allows us to catch
66       * customizations that are not used by anybody.
67       */
68      public void markAsAcknowledged() {
69          acknowledged = true;
70      }
71  
72      public CPluginCustomization(Element element, Locator locator) {
73          this.element = element;
74          this.locator = locator;
75      }
76  
77      public boolean isAcknowledged() {
78          return acknowledged;
79      }
80  }