Интерфейс SOAPElement

public interface SOAPElement
extends Node, Element

Объект, представляющий элемент сообщения SOAP, разрешённый, но не строго предписанный спецификацией SOAP. Этот интерфейс служит базовым интерфейсом для объектов, строго предписанных спецификацией SOAP.

Методы этого интерфейса, обязанные возвращать специфичные для SAAJ объекты, могут «молча» замещать узлы в дереве, чтобы успешно вернуть объекты правильного типа. Подробнее см. getChildElements() и javax.xml.soap .

Методы

addChildElement

SOAPElement addChildElement(Name name)
                     throws SOAPException

Параметры:

name - объект Name с именем XML для нового элемента

Возвращает:

новый объект SOAPElement который был создан

ИСКЛЮЧЕНИЯ:

SOAPException - если возникла ошибка при создании объекта SOAPElement

См. также:

addChildElement(javax.xml.namespace.QName)

addChildElement

SOAPElement addChildElement(QName qname)
                     throws SOAPException

Создаёт новый объект SOAPElement инициализированный заданным объектом QName и добавляет новый элемент к этому объекту SOAPElement. Пространство имён, локальное имя и префикс нового SOAPElement берутся из аргумента qname.

Параметры:

qname - объект QName с именем XML для нового элемента

Возвращает:

новый объект SOAPElement который был создан

ИСКЛЮЧЕНИЯ:

SOAPException - если возникла ошибка при создании объекта SOAPElement

С:

SAAJ 1.3

См. также:

addChildElement(Name)

addChildElement

SOAPElement addChildElement(String localName)
                     throws SOAPException

Создаёт новый объект SOAPElement инициализированный указанным локальным именем и добавляет новый элемент к этому объекту SOAPElement. Новый SOAPElement наследует любые имеющиеся в области действия пространства имён по умолчанию.

Параметры:

localName - String, задающий локальное имя для элемента

Возвращает:

новый объект SOAPElement который был создан

ИСКЛЮЧЕНИЯ:

SOAPException - если возникла ошибка при создании объекта SOAPElement

addChildElement

SOAPElement addChildElement(String localName,
                            String prefix)
                     throws SOAPException

Создаёт новый объект SOAPElement инициализированный указанным локальным именем и префиксом и добавляет новый элемент к этому объекту SOAPElement.

Параметры:

localName - String, задающий локальное имя для нового элемента

prefix - String, задающий префикс имени пространства имён для нового элемента

Возвращает:

новый объект SOAPElement который был создан

ИСКЛЮЧЕНИЯ:

SOAPException - если префикс prefix некорректен в контексте этого SOAPElement или если возникла ошибка при создании объекта SOAPElement

addChildElement

SOAPElement addChildElement(String localName,
                            String prefix,
                            String uri)
                     throws SOAPException

Создаёт новый объект SOAPElement инициализированный указанным локальным именем, префиксом и URI, и добавляет новый элемент к этому объекту SOAPElement.

Параметры:

localName - String, задающий локальное имя для нового элемента

prefix - String, задающий префикс имени пространства имён для нового элемента

uri - String, задающий URI пространства имён, к которому относится новый элемент

Возвращает:

новый объект SOAPElement который был создан

ИСКЛЮЧЕНИЯ:

SOAPException - если возникла ошибка при создании объекта SOAPElement

addChildElement

SOAPElement addChildElement(SOAPElement element)
                     throws SOAPException

Параметры:

element - SOAPElement, который нужно добавить в качестве нового дочернего элемента

Возвращает:

экземпляр, представляющий новый элемент SOAP, который фактически был добавлен в дерево.

ИСКЛЮЧЕНИЯ:

SOAPException - если при добавлении этого элемента в качестве дочернего возникла ошибка

removeContents

void removeContents()

С:

SAAJ 1.2

addTextNode

SOAPElement addTextNode(String text)
                 throws SOAPException

Создаёт новый объект Text инициализированный заданным String и добавляет его к этому объекту SOAPElement.

Параметры:

text - объект String с текстовым содержимым для добавления

Возвращает:

объект SOAPElement , в который был вставлен новый объект Text

ИСКЛЮЧЕНИЯ:

SOAPException - если при создании нового объекта Text или при добавлении его в качестве дочернего к этому SOAPElement произошла ошибка

addAttribute

SOAPElement addAttribute(Name name,
                         String value)
                  throws SOAPException

Добавляет атрибут с указанным именем и значением к этому объекту SOAPElement.

Параметры:

name - объект Name с именем атрибута

value - String, задающий значение атрибута

Возвращает:

объект SOAPElement , в который был вставлен атрибут

ИСКЛЮЧЕНИЯ:

SOAPException - если при создании атрибута или при его установке в объекте SOAPElement произошла ошибка.

См. также:

addAttribute(javax.xml.namespace.QName, String)

addAttribute

SOAPElement addAttribute(QName qname,
                         String value)
                  throws SOAPException

Добавляет атрибут с указанным именем и значением к этому объекту SOAPElement.

Параметры:

qname - объект QName с именем атрибута

value - String, задающий значение атрибута

Возвращает:

объект SOAPElement , в который был вставлен атрибут

ИСКЛЮЧЕНИЯ:

SOAPException - если при создании атрибута или при его установке в объекте SOAPElement произошла ошибка.

С:

SAAJ 1.3

См. также:

addAttribute(Name, String)

addNamespaceDeclaration

SOAPElement addNamespaceDeclaration(String prefix,
                                    String uri)
                             throws SOAPException

Добавляет декларацию пространства имён с указанным префиксом и URI к этому объекту SOAPElement.

Параметры:

prefix - String, задающий префикс пространства имён

uri - String, задающий URI пространства имён

Возвращает:

объект SOAPElement , в который была вставлена декларация пространства имён.

ИСКЛЮЧЕНИЯ:

SOAPException - если при создании пространства имён произошла ошибка

getAttributeValue

String getAttributeValue(Name name)

Возвращает значение атрибута с указанным именем.

Параметры:

name - объект Name с именем атрибута

Возвращает:

String , содержащий значение указанного атрибута, Null, если такого атрибута нет

См. также:

getAttributeValue(javax.xml.namespace.QName)

getAttributeValue

String getAttributeValue(QName qname)

Возвращает значение атрибута с указанным qname.

Параметры:

qname - объект QName с qname атрибута

Возвращает:

String , содержащий значение указанного атрибута, Null, если такого атрибута нет

С:

SAAJ 1.3

См. также:

getAttributeValue(Name)

getAllAttributes

Iterator getAllAttributes()

Возвращает итератор по всем объектам атрибутов Name в этом объекте SOAPElement. Итератор можно использовать для получения имён атрибутов, которые затем можно передать методу getAttributeValue для получения значения каждого атрибута.

Возвращает:

итератор по именам атрибутов

См. также:

getAllAttributesAsQNames()

getAllAttributesAsQNames

Iterator getAllAttributesAsQNames()

Возвращает итератор по всем атрибутам в этом объекте SOAPElement в виде объектов QName. Итератор можно использовать для получения QName атрибута, который затем можно передать методу getAttributeValue для получения значения каждого атрибута.

Возвращает:

итератор по QName атрибутов

С:

SAAJ 1.3

См. также:

getAllAttributes()

getNamespaceURI

String getNamespaceURI(String prefix)

Возвращает URI пространства имён с заданным префиксом.

Параметры:

prefix - a String, задающий префикс пространства имён, для которого выполняется поиск

Возвращает:

a String с URI пространства имён с заданным префиксом

getNamespacePrefixes

Iterator getNamespacePrefixes()

Возвращает Iterator по префиксам пространств имён, объявленным этим элементом. Префиксы, возвращённые этим итератором, могут быть переданы в метод getNamespaceURI, чтобы получить URI каждого пространства имён.

Возвращает:

итератор по префиксам пространств имён в этом объекте SOAPElement

getVisibleNamespacePrefixes

Iterator getVisibleNamespacePrefixes()

Возвращает Iterator по префиксам пространств имён, видимым для этого элемента. Префиксы, возвращённые этим итератором, могут быть переданы в метод getNamespaceURI, чтобы получить URI каждого пространства имён.

Возвращает:

итератор по префиксам пространств имён, доступным в области видимости этого объекта SOAPElement

С тех пор:

SAAJ 1.2

createQName

QName createQName(String localName,
                  String prefix)
           throws SOAPException

Создаёт QName, URI пространства имён которого соответствует параметру prefix, в контексте этого SOAPElement. Остальные элементы нового QName берутся непосредственно из параметров localName и prefix.

Параметры:

localName - a String, содержащий локальную часть имени.

prefix - a String, содержащий префикс имени.

Возвращает:

a QName со специфицированным localName и prefix, и пространством имён, связанным с prefix в контексте этого SOAPElement. Это пространство имён будет таким же, как и то, что вернул бы метод getNamespaceURI(String) при получении prefix в качестве параметра.

Исключение:

SOAPException - если QName не может быть создан.

С тех пор:

SAAJ 1.3

getElementName

Name getElementName()

Возвращает имя этого объекта SOAPElement.

Возвращает:

объект Name с именем этого объекта SOAPElement

getElementQName

QName getElementQName()

Возвращает qname этого объекта SOAPElement.

Возвращает:

объект QName с qname этого объекта SOAPElement

С тех пор:

SAAJ 1.3

См. также:

getElementName()

setElementQName

SOAPElement setElementQName(QName newName)
                     throws SOAPException

Параметры:

newName - новое имя для Element.

Возвращает:

Переименованный узел

Исключение:

SOAPException - если изменение имени этого Element запрещено.

С тех пор:

SAAJ 1.3

removeAttribute

boolean removeAttribute(Name name)

Удаляет атрибут с указанным именем.

Параметры:

name - объект Name с именем удаляемого атрибута

Возвращает:

true если атрибут был удалён успешно; false если нет

См. также:

removeAttribute(javax.xml.namespace.QName)

removeAttribute

boolean removeAttribute(QName qname)

Удаляет атрибут с указанным qname.

Параметры:

qname - объект QName с qname удаляемого атрибута

Возвращает:

true если атрибут был удалён успешно; false если нет

С тех пор:

SAAJ 1.3

См. также:

removeAttribute(Name)

removeNamespaceDeclaration

boolean removeNamespaceDeclaration(String prefix)

Удаляет объявление пространства имён, соответствующее заданному префиксу.

Параметры:

prefix - a String, задающий префикс для поиска

Возвращает:

true если объявление пространства имён было удалено успешно; false если нет

getChildElements

Iterator getChildElements()

Возвращает:

итератор с содержимым этого объекта SOAPElement

getChildElements

Iterator getChildElements(Name name)

Параметры:

name - объект Name с именем возвращаемых дочерних элементов

Возвращает:

объект Iterator по всем элементам в этом объекте SOAPElement с указанным именем

См. также:

getChildElements(javax.xml.namespace.QName)

getChildElements

Iterator getChildElements(QName qname)

Параметры:

qname - объект QName с qname возвращаемых дочерних элементов

Возвращает:

объект Iterator по всем элементам в этом объекте SOAPElement с указанным qname

С тех пор:

SAAJ 1.3

См. также:

getChildElements(Name)

setEncodingStyle

void setEncodingStyle(String encodingStyle)
               throws SOAPException

Устанавливает стиль кодирования для этого объекта SOAPElement на указанный.

Параметры:

encodingStyle - a String, задающий стиль кодирования

Исключение:

IllegalArgumentException - если возникла проблема при установке стиля кодирования.

SOAPException - если установка encodingStyle недопустима для этого SOAPElement.

См. также:

getEncodingStyle()

getEncodingStyle

String getEncodingStyle()

Возвращает стиль кодирования для этого объекта SOAPElement.

Возвращает:

a String, задающий стиль кодирования

См. также:

setEncodingStyle(java.lang.String)