001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package com.sun.xml.stream.xerces.xni;
059:
060: import java.util.Enumeration;
061:
062: /**
063: * The Augmentations interface defines a table of additional data that may
064: * be passed along the document pipeline. The information can contain extra
065: * arguments or infoset augmentations, for example PSVI. This additional
066: * information is identified by a String key.
067: * <p>
068: * <strong>Note:</strong>
069: * Methods that receive Augmentations are required to copy the information
070: * if it is to be saved for use beyond the scope of the method.
071: * The Augmentations content is volatile, and maybe modified by any method in
072: * any component in the pipeline. Therefore, methods passed this structure
073: * should not save any reference to the structure.
074: *
075: * @author Elena Litani, IBM
076: * @version $Id: Augmentations.java,v 1.2 2006/04/01 06:01:45 jeffsuttor Exp $
077: */
078:
079: public interface Augmentations {
080:
081: /**
082: * Add additional information identified by a key to the Augmentations structure.
083: *
084: * @param key Identifier, can't be <code>null</code>
085: * @param item Additional information
086: *
087: * @return the previous value of the specified key in the Augmentations structure,
088: * or <code>null</code> if it did not have one.
089: */
090: public Object putItem(String key, Object item);
091:
092: /**
093: * Get information identified by a key from the Augmentations structure
094: *
095: * @param key Identifier, can't be <code>null</code>
096: *
097: * @return the value to which the key is mapped in the Augmentations structure;
098: * <code>null</code> if the key is not mapped to any value.
099: */
100: public Object getItem(String key);
101:
102: /**
103: * Remove additional info from the Augmentations structure
104: *
105: * @param key Identifier, can't be <code>null</code>
106: * @return the previous value of the specified key in the Augmentations structure,
107: * or <code>null</code> if it did not have one.
108: */
109: public Object removeItem(String key);
110:
111: /**
112: * Returns an enumeration of the keys in the Augmentations structure
113: *
114: */
115: public Enumeration keys();
116:
117: /**
118: * Remove all objects from the Augmentations structure.
119: */
120: public void removeAllItems();
121:
122: }
|