AbstractXMLObject (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.opensaml.xml.AbstractXMLObject

すべての実装されたインタフェース:

XMLObject

直系の既知のサブクラス:

AbstractSignableXMLObject, AbstractValidatingXMLObject, AddressImpl, AppliesToImpl, EndPointReferenceImpl, RequestedSecurityTokenImpl, RequestSecurityTokenResponseImpl, SignatureImpl
```
public abstract class AbstractXMLObject
extends Object
implements XMLObject
```
An abstract implementation of XMLObject.

コンストラクタの概要

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`AbstractXMLObject(String namespaceURI, String elementLocalName, String namespacePrefix)` Constructor.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`addNamespace(Namespace newNamespace)` Adds a namespace to the ones already scoped to this element.
`void`	`detach()` Detaches the XMLObject from its parent.
`Element`	`getDOM()` Gets the DOM representation of this XMLObject, if one exists.
`QName`	`getElementQName()` Gets the QName for this element.
`IDIndex`	`getIDIndex()` Get the IDIndex holding the ID-to-XMLObject index mapping, rooted at this XMLObject's subtree.
`NamespaceManager`	`getNamespaceManager()` Gets the `NamespaceManager` instance for this object.
`Set<Namespace>`	`getNamespaces()` Gets the namespaces that are scoped to this element.
`String`	`getNoNamespaceSchemaLocation()` Gets the value of the XML Schema noNamespaceSchemaLocation attribute for this object.
`XMLObject`	`getParent()` Gets the parent of this element.
`String`	`getSchemaLocation()` Gets the value of the XML Schema schemaLocation attribute for this object.
`QName`	`getSchemaType()` Gets the XML schema type of this element.
`boolean`	`hasChildren()` Checks if this XMLObject has children.
`boolean`	`hasParent()` Checks to see if this object has a parent.
`Boolean`	`isNil()` Gets whether the object declares that its element content is null, which corresponds to an `xsi:nil` attribute of `true`.
`XSBooleanValue`	`isNilXSBoolean()` Gets whether the object declares that its element content is null, which corresponds to an `xsi:nil` attribute of `true`.
`protected void`	`manageQualifiedAttributeNamespace(QName attributeName, boolean hasValue)` A helper function for derived classes.
`protected QName`	`prepareAttributeValueForAssignment(String attributeID, QName oldValue, QName newValue)` A helper function for derived classes.
`protected QName`	`prepareElementContentForAssignment(QName oldValue, QName newValue)` A helper function for derived classes.
`protected QName`	`prepareForAssignment(QName oldValue, QName newValue)` 推奨されていません。 replacement `prepareAttributeValueForAssignment(String, QName, QName)` or `prepareElementContentForAssignment(QName, QName)` as appropriate
`protected String`	`prepareForAssignment(String oldValue, String newValue)` A helper function for derived classes.
`protected <T> T`	`prepareForAssignment(T oldValue, T newValue)` A helper function for derived classes that checks to see if the old and new value are equal and if so releases the cached dom.
`protected <T extends XMLObject> T`	`prepareForAssignment(T oldValue, T newValue)` A helper function for derived classes, similar to assignString, but for (singleton) SAML objects.
`protected void`	`registerOwnID(String oldID, String newID)` A helper function for derived classes.
`void`	`releaseChildrenDOM(boolean propagateRelease)` Releases the DOM representation of this XMLObject's children.
`void`	`releaseDOM()` Releases the DOM representation of this XMLObject, if there is one.
`void`	`releaseParentDOM(boolean propagateRelease)` Releases the DOM representation of this XMLObject's parent.
`void`	`releaseThisAndChildrenDOM()` A convience method that is equal to calling `releaseDOM()` then `releaseChildrenDOM(boolean)` with the release being propogated.
`void`	`releaseThisandParentDOM()` A convience method that is equal to calling `releaseDOM()` then `releaseParentDOM(boolean)` with the release being propogated.
`void`	`removeNamespace(Namespace namespace)` Removes a namespace from this element.
`XMLObject`	`resolveID(String id)` Find the XMLObject which is identified by the specified ID attribute, within the subtree of XMLObjects which has this XMLObject as its root.
`XMLObject`	`resolveIDFromRoot(String id)` Find the XMLObject which is identified by the specified ID attribute, from the root of the tree of XMLObjects in which this XMLObject is a member.
`void`	`setDOM(Element newDom)` Sets the DOM representation of this XMLObject.
`void`	`setElementNamespacePrefix(String prefix)` Sets the prefix for this element's namespace.
`protected void`	`setElementQName(QName elementQName)` Sets the element QName.
`void`	`setNil(Boolean newNil)` Sets whether the object declares that its element content is null, which corresponds to an `xsi:nil` attribute of `true`.
`void`	`setNil(XSBooleanValue newNil)` Sets whether the object declares that its element content is null, which corresponds to an `xsi:nil` attribute of `true`.
`void`	`setNoNamespaceSchemaLocation(String location)` Sets the value of the XML Schema noNamespaceSchemaLocation attribute for this object.
`void`	`setParent(XMLObject newParent)` Sets the parent of this element.
`void`	`setSchemaLocation(String location)` Sets the value of the XML Schema schemaLocation attribute for this object.
`protected void`	`setSchemaType(QName type)` Sets a given QName as the schema type for the Element represented by this XMLObject.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.opensaml.xml.XMLObject
getOrderedChildren

- コンストラクタの詳細
  - AbstractXMLObject
```
protected AbstractXMLObject(String namespaceURI,
                 String elementLocalName,
                 String namespacePrefix)
```
    Constructor.
    
    パラメータ:
    namespaceURI - the namespace the element is in
    elementLocalName - the local name of the XML element this Object represents
    namespacePrefix - the prefix for the given namespace
- メソッドの詳細
  - addNamespace
```
public void addNamespace(Namespace newNamespace)
```
    Adds a namespace to the ones already scoped to this element.
    
    定義:
    
    addNamespace インタフェース内 XMLObject
    
    パラメータ:
    newNamespace - the namespace to add
  - detach
```
public void detach()
```
    Detaches the XMLObject from its parent. This will release the parent's cached DOM (if it has one) and set this object's parent to null. It does not remove this object from its parent, that's the responsibility of the invoker of this method, nor does it re-root the cached DOM node (if there is one) in a new document. This is handled at marshalling time.
    
    定義:
    
    detach インタフェース内 XMLObject
  - getDOM
```
public Element getDOM()
```
    Gets the DOM representation of this XMLObject, if one exists.
    
    定義:
    
    getDOM インタフェース内 XMLObject
    
    戻り値:
    the DOM representation of this XMLObject
  - getElementQName
```
public QName getElementQName()
```
    Gets the QName for this element. This QName MUST contain the namespace URI, namespace prefix, and local element name. Changes made to the returned QName are not reflected by the QName held by this element, that is, the returned QName is a copy of the internal QName member of this class.
    
    定義:
    
    getElementQName インタフェース内 XMLObject
    
    戻り値:
    the QName for this attribute
  - getIDIndex
```
public IDIndex getIDIndex()
```
    Get the IDIndex holding the ID-to-XMLObject index mapping, rooted at this XMLObject's subtree.
    
    定義:
    
    getIDIndex インタフェース内 XMLObject
    
    戻り値:
    the IDIndex owned by this XMLObject
  - getNamespaceManager
```
public NamespaceManager getNamespaceManager()
```
    Gets the NamespaceManager instance for this object.
    
    定義:
    
    getNamespaceManager インタフェース内 XMLObject
    
    戻り値:
    the namespace manager for this object
  - getNamespaces
```
public Set<Namespace> getNamespaces()
```
    Gets the namespaces that are scoped to this element.
    
    定義:
    
    getNamespaces インタフェース内 XMLObject
    
    戻り値:
    the namespaces that are scoped to this element
  - getNoNamespaceSchemaLocation
```
public String getNoNamespaceSchemaLocation()
```
    Gets the value of the XML Schema noNamespaceSchemaLocation attribute for this object.
    
    定義:
    
    getNoNamespaceSchemaLocation インタフェース内 XMLObject
    
    戻り値:
    value of the XML Schema noNamespaceSchemaLocation attribute for this object
  - getParent
```
public XMLObject getParent()
```
    Gets the parent of this element.
    
    定義:
    
    getParent インタフェース内 XMLObject
    
    戻り値:
    the parent of this element
  - getSchemaLocation
```
public String getSchemaLocation()
```
    Gets the value of the XML Schema schemaLocation attribute for this object.
    
    定義:
    
    getSchemaLocation インタフェース内 XMLObject
    
    戻り値:
    schema location defined for this object
  - getSchemaType
```
public QName getSchemaType()
```
    Gets the XML schema type of this element. This translates to contents the xsi:type attribute for the element.
    
    定義:
    
    getSchemaType インタフェース内 XMLObject
    
    戻り値:
    XML schema type of this element
  - hasChildren
```
public boolean hasChildren()
```
    Checks if this XMLObject has children.
    
    定義:
    
    hasChildren インタフェース内 XMLObject
    
    戻り値:
    true if this XMLObject has children, false if not
  - hasParent
```
public boolean hasParent()
```
    Checks to see if this object has a parent.
    
    定義:
    
    hasParent インタフェース内 XMLObject
    
    戻り値:
    true if the object has a parent, false if not
  - manageQualifiedAttributeNamespace
```
protected void manageQualifiedAttributeNamespace(QName attributeName,
                                     boolean hasValue)
```
    A helper function for derived classes. This method should be called when the value of a namespace-qualified attribute changes.
    
    パラメータ:
    attributeName - the attribute name
    hasValue - true to indicate that the attribute has a value, false to indicate it has no value
  - prepareForAssignment
```
protected QName prepareForAssignment(QName oldValue,
                         QName newValue)
```
    推奨されていません。 replacement prepareAttributeValueForAssignment(String, QName, QName) or prepareElementContentForAssignment(QName, QName) as appropriate
    
    A helper function for derived classes. This checks for semantic equality between two QNames if it they are different invalidates the DOM. It returns the normalized value so subclasses just have to go. this.foo = prepareForAssignment(this.foo, foo);
    
    パラメータ:
    oldValue - - the current value
    newValue - - the new value
    
    戻り値:
    the value that should be assigned
  - prepareElementContentForAssignment
```
protected QName prepareElementContentForAssignment(QName oldValue,
                                       QName newValue)
```
    A helper function for derived classes. This checks for semantic equality between two QNames if it they are different invalidates the DOM. It returns the normalized value so subclasses just have to go. this.foo = prepareElementContentForAssignment(this.foo, foo);
    
    パラメータ:
    oldValue - - the current value
    newValue - - the new value
    
    戻り値:
    the value that should be assigned
  - prepareAttributeValueForAssignment
```
protected QName prepareAttributeValueForAssignment(String attributeID,
                                       QName oldValue,
                                       QName newValue)
```
    A helper function for derived classes. This checks for semantic equality between two QNames if it they are different invalidates the DOM. It returns the normalized value so subclasses just have to go. this.foo = prepareAttributeValueForAssignment(this.foo, foo);
    
    パラメータ:
    attributeID - - unique identifier of the attribute in the content model within this XMLObject, used to identify the attribute within the XMLObject's NamespaceManager
    oldValue - - the current value
    newValue - - the new value
    
    戻り値:
    the value that should be assigned
  - prepareForAssignment
```
protected String prepareForAssignment(String oldValue,
                          String newValue)
```
    A helper function for derived classes. This 'nornmalizes' newString and then if it is different from oldString invalidates the DOM. It returns the normalized value so subclasses just have to go. this.foo = prepareForAssignment(this.foo, foo);
    
    パラメータ:
    oldValue - - the current value
    newValue - - the new value
    
    戻り値:
    the value that should be assigned
  - prepareForAssignment
```
protected <T> T prepareForAssignment(T oldValue,
                         T newValue)
```
    A helper function for derived classes that checks to see if the old and new value are equal and if so releases the cached dom. Derived classes are expected to use this thus: this.foo = prepareForAssignment(this.foo, foo); This method will do a (null) safe compare of the objects and will also invalidate the DOM if appropriate
    
    型パラメータ:
    T - - type of object being compared and assigned
    パラメータ:
    oldValue - - current value
    newValue - - proposed new value
    
    戻り値:
    The value to assign to the saved Object.
  - prepareForAssignment
```
protected <T extends XMLObject> T prepareForAssignment(T oldValue,
                                           T newValue)
```
    A helper function for derived classes, similar to assignString, but for (singleton) SAML objects. It is indifferent to whether either the old or the new version of the value is null. Derived classes are expected to use this thus: this.foo = prepareForAssignment(this.foo, foo); This method will do a (null) safe compare of the objects and will also invalidate the DOM if appropriate
    
    型パラメータ:
    T - type of object being compared and assigned
    パラメータ:
    oldValue - current value
    newValue - proposed new value
    
    戻り値:
    The value to assign to the saved Object.
  - registerOwnID
```
protected void registerOwnID(String oldID,
                 String newID)
```
    A helper function for derived classes. The mutator/setter method for any ID-typed attributes should call this method in order to handle getting the old value removed from the ID-to-XMLObject mapping, and the new value added to the mapping.
    
    パラメータ:
    oldID - the old value of the ID-typed attribute
    newID - the new value of the ID-typed attribute
  - releaseChildrenDOM
```
public void releaseChildrenDOM(boolean propagateRelease)
```
    Releases the DOM representation of this XMLObject's children.
    
    定義:
    
    releaseChildrenDOM インタフェース内 XMLObject
    
    パラメータ:
    propagateRelease - true if all descendants of this element should release their DOM
  - releaseDOM
```
public void releaseDOM()
```
    Releases the DOM representation of this XMLObject, if there is one.
    
    定義:
    
    releaseDOM インタフェース内 XMLObject
  - releaseParentDOM
```
public void releaseParentDOM(boolean propagateRelease)
```
    Releases the DOM representation of this XMLObject's parent.
    
    定義:
    
    releaseParentDOM インタフェース内 XMLObject
    
    パラメータ:
    propagateRelease - true if all ancestors of this element should release their DOM
  - releaseThisAndChildrenDOM
```
public void releaseThisAndChildrenDOM()
```
    A convience method that is equal to calling releaseDOM() then releaseChildrenDOM(boolean) with the release being propogated.
  - releaseThisandParentDOM
```
public void releaseThisandParentDOM()
```
    A convience method that is equal to calling releaseDOM() then releaseParentDOM(boolean) with the release being propogated.
  - removeNamespace
```
public void removeNamespace(Namespace namespace)
```
    Removes a namespace from this element.
    
    定義:
    
    removeNamespace インタフェース内 XMLObject
    
    パラメータ:
    namespace - the namespace to remove
  - resolveID
```
public XMLObject resolveID(String id)
```
    Find the XMLObject which is identified by the specified ID attribute, within the subtree of XMLObjects which has this XMLObject as its root.
    
    定義:
    
    resolveID インタフェース内 XMLObject
    
    パラメータ:
    id - the ID attribute to resolve to an XMLObject
    
    戻り値:
    the XMLObject identified by the specified ID attribute value
  - resolveIDFromRoot
```
public XMLObject resolveIDFromRoot(String id)
```
    Find the XMLObject which is identified by the specified ID attribute, from the root of the tree of XMLObjects in which this XMLObject is a member.
    
    定義:
    
    resolveIDFromRoot インタフェース内 XMLObject
    
    パラメータ:
    id - the ID attribute to resolve to an XMLObject
    
    戻り値:
    the XMLObject identified by the specified ID attribute value
  - setDOM
```
public void setDOM(Element newDom)
```
    Sets the DOM representation of this XMLObject.
    
    定義:
    
    setDOM インタフェース内 XMLObject
    
    パラメータ:
    newDom - DOM representation of this XMLObject
  - setElementNamespacePrefix
```
public void setElementNamespacePrefix(String prefix)
```
    Sets the prefix for this element's namespace.
    
    パラメータ:
    prefix - the prefix for this element's namespace
  - setElementQName
```
protected void setElementQName(QName elementQName)
```
    Sets the element QName.
    
    パラメータ:
    elementQName - the element's QName
  - setNoNamespaceSchemaLocation
```
public void setNoNamespaceSchemaLocation(String location)
```
    Sets the value of the XML Schema noNamespaceSchemaLocation attribute for this object.
    
    定義:
    
    setNoNamespaceSchemaLocation インタフェース内 XMLObject
    
    パラメータ:
    location - value of the XML Schema noNamespaceSchemaLocation attribute for this object
  - setParent
```
public void setParent(XMLObject newParent)
```
    Sets the parent of this element.
    
    定義:
    
    setParent インタフェース内 XMLObject
    
    パラメータ:
    newParent - the parent of this element
  - setSchemaLocation
```
public void setSchemaLocation(String location)
```
    Sets the value of the XML Schema schemaLocation attribute for this object.
    
    定義:
    
    setSchemaLocation インタフェース内 XMLObject
    
    パラメータ:
    location - value of the XML Schema schemaLocation attribute for this object
  - setSchemaType
```
protected void setSchemaType(QName type)
```
    Sets a given QName as the schema type for the Element represented by this XMLObject. This will register the namespace for the type as well as for the xsi:type qualified attribute name with the namespace manager for this XMLObject. If null is passed, the type name and xsi:type name will be deregistered.
    
    パラメータ:
    type - the schema type
  - isNil
```
public Boolean isNil()
```
    Gets whether the object declares that its element content is null, which corresponds to an xsi:nil attribute of true.
    Note that it is up to the developer to ensure that the value of this attribute is consistent with the actual element content on the object instance.
    
    Per the XML Schema specification, a value of true disallows element content, but not element attributes.
    
    定義:
    
    isNil インタフェース内 XMLObject
    
    戻り値:
    whether the object's content model is null
    関連項目:
  - isNilXSBoolean
```
public XSBooleanValue isNilXSBoolean()
```
    Gets whether the object declares that its element content is null, which corresponds to an xsi:nil attribute of true.
    Note that it is up to the developer to ensure that the value of this attribute is consistent with the actual element content on the object instance.
    
    Per the XML Schema specification, a value of true disallows element content, but not element attributes.
    定義:
    
    isNilXSBoolean インタフェース内 XMLObject
    
    戻り値:
    whether the object's content model is null
    関連項目:
    setNil
    
    public void setNil(Boolean newNil)
    
    Sets whether the object declares that its element content is null, which corresponds to an xsi:nil attribute of true.
    Note that it is up to the developer to ensure that the value of this attribute is consistent with the actual element content on the object instance.
    
    Per the XML Schema specification, a value of true disallows element content, but not element attributes.
    
    定義:
    
    setNil インタフェース内 XMLObject
    
    パラメータ:
    newNil - whether the object's content model is expressed as null
    関連項目:
    
    setNil
    
    public void setNil(XSBooleanValue newNil)
    
    Sets whether the object declares that its element content is null, which corresponds to an xsi:nil attribute of true.
    Note that it is up to the developer to ensure that the value of this attribute is consistent with the actual element content on the object instance.
    
    Per the XML Schema specification, a value of true disallows element content, but not element attributes.
    
    定義:
    
    setNil インタフェース内 XMLObject
    
    パラメータ:
    newNil - whether the object's content model is expressed as null
    関連項目:
    
    概要
    
    パッケージ
    
    クラス
    
    使用
    
    階層ツリー
    
    非推奨
    
    索引
    
    ヘルプ

すべてのクラス

概要:
ネスト |
フィールド |
コンストラクタ |
メソッド

詳細:
フィールド |
コンストラクタ |
メソッド

クラス AbstractXMLObject

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド org.opensaml.xml.XMLObject

コンストラクタの詳細

AbstractXMLObject

メソッドの詳細

addNamespace

detach

getDOM

getElementQName

getIDIndex

getNamespaceManager

getNamespaces

getNoNamespaceSchemaLocation

getParent

getSchemaLocation

getSchemaType

hasChildren

hasParent

manageQualifiedAttributeNamespace

prepareForAssignment

prepareElementContentForAssignment

prepareAttributeValueForAssignment

prepareForAssignment

prepareForAssignment

prepareForAssignment

registerOwnID

releaseChildrenDOM

releaseDOM

releaseParentDOM

releaseThisAndChildrenDOM

releaseThisandParentDOM

removeNamespace

resolveID

resolveIDFromRoot

setDOM

setElementNamespacePrefix

setElementQName

setNoNamespaceSchemaLocation

setParent

setSchemaLocation

setSchemaType

isNil

isNilXSBoolean

setNil

setNil