com.sun.tools.xjc.model.CPluginCustomization Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.model;
import com.sun.tools.xjc.Plugin;
import org.w3c.dom.Element;
import org.xml.sax.Locator;
/**
* Vendor extension customization contributed from {@link Plugin}s.
*
* @author Kohsuke Kawaguchi
*/
public class CPluginCustomization {
/**
* The annotation found in a schema (or in an external binding file.)
*
* Always non-null.
*/
public final Element element;
/**
* The source location where this customization is placed.
*
*
* When an error is found in this customization, this information
* should be used to point the user to the source of the problem.
*
* Always non-nul.
*/
public final Locator locator;
private boolean acknowledged;
/**
* When a {@link Plugin} "uses" this annotation, call this method
* to mark it.
*
*
* {@link CPluginCustomization}s that are not marked will be
* reporeted as an error to users. This allows us to catch
* customizations that are not used by anybody.
*/
public void markAsAcknowledged() {
acknowledged = true;
}
public CPluginCustomization(Element element, Locator locator) {
this.element = element;
this.locator = locator;
}
public boolean isAcknowledged() {
return acknowledged;
}
}