com.sun.org.apache.xerces.internal.xni.Augmentations Maven / Gradle / Ivy
Show all versions of jaxp-ri Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.sun.org.apache.xerces.internal.xni;
import java.util.Enumeration;
/**
* The Augmentations interface defines a table of additional data that may
* be passed along the document pipeline. The information can contain extra
* arguments or infoset augmentations, for example PSVI. This additional
* information is identified by a String key.
*
* Note:
* Methods that receive Augmentations are required to copy the information
* if it is to be saved for use beyond the scope of the method.
* The Augmentations content is volatile, and maybe modified by any method in
* any component in the pipeline. Therefore, methods passed this structure
* should not save any reference to the structure.
*
* @author Elena Litani, IBM
* @version $Id: Augmentations.java,v 1.6 2010-11-01 04:40:18 joehw Exp $
*/
public interface Augmentations {
/**
* Add additional information identified by a key to the Augmentations structure.
*
* @param key Identifier, can't be null
* @param item Additional information
*
* @return the previous value of the specified key in the Augmentations structure,
* or null
if it did not have one.
*/
public Object putItem (String key, Object item);
/**
* Get information identified by a key from the Augmentations structure
*
* @param key Identifier, can't be null
*
* @return the value to which the key is mapped in the Augmentations structure;
* null
if the key is not mapped to any value.
*/
public Object getItem(String key);
/**
* Remove additional info from the Augmentations structure
*
* @param key Identifier, can't be null
* @return the previous value of the specified key in the Augmentations structure,
* or null
if it did not have one.
*/
public Object removeItem (String key);
/**
* Returns an enumeration of the keys in the Augmentations structure
*
*/
public Enumeration keys ();
/**
* Remove all objects from the Augmentations structure.
*/
public void removeAllItems ();
}