com.sun.tools.ws.wsdl.framework.Entity Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.ws.wsdl.framework;
import org.xml.sax.Locator;
import java.util.HashMap;
import java.util.Map;
import com.sun.tools.ws.wscompile.ErrorReceiver;
/**
* An entity, typically corresponding to an XML element.
*
* @author WS Development Team
*/
public abstract class Entity implements Elemental {
private final Locator locator;
protected ErrorReceiver errorReceiver;
public Entity(Locator locator) {
this.locator = locator;
}
public void setErrorReceiver(ErrorReceiver errorReceiver) {
this.errorReceiver = errorReceiver;
}
public Locator getLocator() {
return locator;
}
public Object getProperty(String key) {
if (_properties == null)
return null;
return _properties.get(key);
}
public void setProperty(String key, Object value) {
if (value == null) {
removeProperty(key);
return;
}
if (_properties == null) {
_properties = new HashMap();
}
_properties.put(key, value);
}
public void removeProperty(String key) {
if (_properties != null) {
_properties.remove(key);
}
}
public void withAllSubEntitiesDo(EntityAction action) {
// no-op by default
}
public void withAllQNamesDo(QNameAction action) {
action.perform(getElementName());
}
public void withAllEntityReferencesDo(EntityReferenceAction action) {
// no-op by default
}
public abstract void validateThis();
protected void failValidation(String key) {
throw new ValidationException(key, getElementName().getLocalPart());
}
protected void failValidation(String key, String arg) {
throw new ValidationException(
key,
new Object[] { arg, getElementName().getLocalPart()});
}
private Map _properties;
}