com.sun.msv.grammar.ReferenceContainer Maven / Gradle / Ivy
/*
* Copyright (c) 2001-2013 Oracle and/or its affiliates. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of Oracle nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.sun.msv.grammar;
import java.util.Iterator;
import java.util.Map;
/**
* Container of ReferenceExp. a map from name to ReferenceExp.
*
* @author Kohsuke KAWAGUCHI
*/
public abstract class ReferenceContainer implements java.io.Serializable {
protected final Map impl = new java.util.HashMap();
/**
* gets or creates ReferenceExp object.
*
* Derived class should provide type-safe accesser methods.
*
* Usually, this method is only necessary for some kind of grammar loader.
* If you are programming an application over MSV,
* {@link #_get(String)} method is probably what you need.
*/
public final ReferenceExp _getOrCreate( String name ) {
Object o = impl.get(name);
if(o!=null) return (ReferenceExp)o;
// this is the first time this name is used.
// so create a ReferenceExp here.
ReferenceExp exp = createReference(name);
impl.put(name,exp);
return exp;
}
/** creates a new reference object with given name */
protected abstract ReferenceExp createReference( String name );
/**
* replaces the current ReferenceExp by newly specified reference exp.
*/
public void redefine( String name, ReferenceExp newExp ) {
if( impl.put(name,newExp)==null )
// no object is associated with this name.
throw new IllegalArgumentException();
}
/** gets a referenced expression
*
* Derived class should provide type-safe accesser methods.
*
* @return null
* if no expression is defined with the given name.
*/
public final ReferenceExp _get( String name ) {
Object o = impl.get(name);
if(o!=null) return (ReferenceExp)o;
else return null; // not found
}
/** iterates all ReferenceExp in this container */
public final Iterator iterator() {
return impl.values().iterator();
}
/** obtains all items in this container. */
public final ReferenceExp[] getAll() {
ReferenceExp[] r = new ReferenceExp[size()];
impl.values().toArray(r);
return r;
}
/** removes an object from this container.
*
* @return
* removed object. Null if no such name is found.
*/
public final ReferenceExp remove( String name ) {
return (ReferenceExp)impl.remove(name);
}
/** gets the number of ReferenceExps in this container. */
public final int size() {
return impl.size();
}
// serialization support
private static final long serialVersionUID = 1;
}