NamespaceContext2.java revision dff2cc5646d4437ab9e0cb1dcb59da65462a5938
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail//
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v1.0.6-b27-fcs
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail// See <a href="http://java.sun.com/xml/jaxb">http://java.sun.com/xml/jaxb</a>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail// Any modifications to this file will be lost upon recompilation of the source schema.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail// Generated on: 2012.06.11 at 10:34:07 AM PDT
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail//
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailpackage com.sun.identity.saml2.jaxb.assertion.impl.runtime;
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailimport javax.xml.namespace.NamespaceContext;
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail/**
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * Maintains namespace&lt;->prefix bindings.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * <p>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * This interface extends {@link NamespaceContext} and provides
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * an additional functionality, which is necessary to declare
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * namespaced attributes on elements. The added method is for
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * self-consumption by the marshaller.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * This object is composed into a Serializer.
ec3706caae60369bd59b4a7a2de365fc74637504Vasumathi Sundaram */
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbailpublic interface NamespaceContext2 extends NamespaceContext
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail{
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail /**
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * Declares a new namespace binding within the current context.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * <p>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * The prefix is automatically assigned by MarshallingContext. If
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * a given namespace URI is already declared, nothing happens.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * <p>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * It is <b>NOT</b> an error to declare the same namespace URI
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * more than once.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * <p>
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * For marshalling to work correctly, all namespace bindings
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * for an element must be declared between its startElement method and
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * its endAttributes event. Calling the same method with the same
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * parameter between the endAttributes and the endElement returns
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * the same prefix.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * @param requirePrefix
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * If this parameter is true, this method must assign a prefix
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * to this namespace, even if it's already bound to the default
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * namespace. IOW, this method will never return null if this
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * flag is true. This functionality is necessary to declare
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * namespace URI used for attribute names.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * @param preferedPrefix
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * If the caller has any particular preference to the
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * prefix, pass that as a parameter. The callee will try
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * to honor it. Set null if there's no particular preference.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail *
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * @return
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * returns the assigned prefix. If the namespace is bound to
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail * the default namespace, null is returned.
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail */
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail String declareNamespace( String namespaceUri, String preferedPrefix, boolean requirePrefix );
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail}
6e91bba0d6c6bdabbba62cefae583715a4a58e2aGirish Moodalbail