1. /*
  2. * The Apache Software License, Version 1.1
  3. *
  4. *
  5. * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
  6. * reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in
  17. * the documentation and/or other materials provided with the
  18. * distribution.
  19. *
  20. * 3. The end-user documentation included with the redistribution,
  21. * if any, must include the following acknowledgment:
  22. * "This product includes software developed by the
  23. * Apache Software Foundation (http://www.apache.org/)."
  24. * Alternately, this acknowledgment may appear in the software itself,
  25. * if and wherever such third-party acknowledgments normally appear.
  26. *
  27. * 4. The names "Xerces" and "Apache Software Foundation" must
  28. * not be used to endorse or promote products derived from this
  29. * software without prior written permission. For written
  30. * permission, please contact apache@apache.org.
  31. *
  32. * 5. Products derived from this software may not be called "Apache",
  33. * nor may "Apache" appear in their name, without prior written
  34. * permission of the Apache Software Foundation.
  35. *
  36. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  37. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  38. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  39. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  40. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  43. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  44. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  45. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  46. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47. * SUCH DAMAGE.
  48. * ====================================================================
  49. *
  50. * This software consists of voluntary contributions made by many
  51. * individuals on behalf of the Apache Software Foundation and was
  52. * originally based on software copyright (c) 1999, International
  53. * Business Machines, Inc., http://www.apache.org. For more
  54. * information on the Apache Software Foundation, please see
  55. * <http://www.apache.org/>.
  56. */
  57. package com.sun.org.apache.xerces.internal.xni;
  58. import java.util.Enumeration;
  59. /**
  60. * The Augmentations interface defines a table of additional data that may
  61. * be passed along the document pipeline. The information can contain extra
  62. * arguments or infoset augmentations, for example PSVI. This additional
  63. * information is identified by a String key.
  64. * <p>
  65. * <strong>Note:</strong>
  66. * Methods that receive Augmentations are required to copy the information
  67. * if it is to be saved for use beyond the scope of the method.
  68. * The Augmentations content is volatile, and maybe modified by any method in
  69. * any component in the pipeline. Therefore, methods passed this structure
  70. * should not save any reference to the structure.
  71. *
  72. * @author Elena Litani, IBM
  73. * @version $Id: Augmentations.java,v 1.6 2003/01/23 17:27:12 sandygao Exp $
  74. */
  75. public interface Augmentations {
  76. /**
  77. * Add additional information identified by a key to the Augmentations structure.
  78. *
  79. * @param key Identifier, can't be <code>null</code>
  80. * @param item Additional information
  81. *
  82. * @return the previous value of the specified key in the Augmentations structure,
  83. * or <code>null</code> if it did not have one.
  84. */
  85. public Object putItem (String key, Object item);
  86. /**
  87. * Get information identified by a key from the Augmentations structure
  88. *
  89. * @param key Identifier, can't be <code>null</code>
  90. *
  91. * @return the value to which the key is mapped in the Augmentations structure;
  92. * <code>null</code> if the key is not mapped to any value.
  93. */
  94. public Object getItem(String key);
  95. /**
  96. * Remove additional info from the Augmentations structure
  97. *
  98. * @param key Identifier, can't be <code>null</code>
  99. * @return the previous value of the specified key in the Augmentations structure,
  100. * or <code>null</code> if it did not have one.
  101. */
  102. public Object removeItem (String key);
  103. /**
  104. * Returns an enumeration of the keys in the Augmentations structure
  105. *
  106. */
  107. public Enumeration keys ();
  108. /**
  109. * Remove all objects from the Augmentations structure.
  110. */
  111. public void removeAllItems ();
  112. }