org.jdom2

类 ProcessingInstruction

java.lang.Object

org.jdom2.Content

org.jdom2.ProcessingInstruction

所有已实现的接口:

java.io.Serializable, java.lang.Cloneable, NamespaceAware

直接已知子类:

LocatedProcessingInstruction

public class ProcessingInstruction
extends Content

An XML processing instruction. Methods allow the user to obtain the target of the PI as well as its data. The data can always be accessed as a String or, if the data appears akin to an attribute list, can be retrieved as name/value pairs.

作者:

Brett McLaughlin, Jason Hunter, Steven Gould

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 org.jdom2.Content

Content.CType

构造器概要

构造器

构造器和说明
ProcessingInstruction(java.lang.String target) This will create a new ProcessingInstruction with the specified target.
ProcessingInstruction(java.lang.String target, java.util.Map<java.lang.String,java.lang.String> data) This will create a new ProcessingInstruction with the specified target and data.
ProcessingInstruction(java.lang.String target, java.lang.String data) This will create a new ProcessingInstruction with the specified target and data.

方法概要

限定符和类型	方法和说明
ProcessingInstruction	clone() Return a deep clone of this instance.
ProcessingInstruction	detach() Detaches this child from its parent or does nothing if the child has no parent.
java.lang.String	getData() This will return the raw data from all instructions.
java.util.List<java.lang.String>	getPseudoAttributeNames() This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.
java.lang.String	getPseudoAttributeValue(java.lang.String name) This will return the value for a specific name/value pair on the PI.
java.lang.String	getTarget() This will retrieve the target of the PI.
java.lang.String	getValue() Returns the XPath 1.0 string value of this element, which is the data of this PI.
boolean	removePseudoAttribute(java.lang.String name) This will remove the pseudo attribute with the specified name.
ProcessingInstruction	setData(java.util.Map<java.lang.String,java.lang.String> data) This will set the name/value pairs within the passed Map as the pairs for the data of this PI.
ProcessingInstruction	setData(java.lang.String data) This will set the raw data for the PI.
ProcessingInstruction	setPseudoAttribute(java.lang.String name, java.lang.String value) This will set a pseudo attribute with the given name and value.
ProcessingInstruction	setTarget(java.lang.String newTarget) This will set the target for the PI.
java.lang.String	toString() This returns a String representation of the ProcessingInstruction, suitable for debugging.

从类继承的方法 org.jdom2.Content

equals, getCType, getDocument, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getParent, getParentElement, hashCode

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

ProcessingInstruction

public ProcessingInstruction(java.lang.String target)

This will create a new ProcessingInstruction with the specified target.

参数:

target - String target of PI.

抛出:

IllegalTargetException - if the given target is illegal as a processing instruction name.

ProcessingInstruction

public ProcessingInstruction(java.lang.String target,
                             java.util.Map<java.lang.String,java.lang.String> data)

This will create a new ProcessingInstruction with the specified target and data.

参数:

target - String target of PI.

data - Map data for PI, in name/value pairs

抛出:

IllegalTargetException - if the given target is illegal as a processing instruction name.

ProcessingInstruction

public ProcessingInstruction(java.lang.String target,
                             java.lang.String data)

This will create a new ProcessingInstruction with the specified target and data.

参数:

target - String target of PI.

data - String data for PI.

抛出:

IllegalTargetException - if the given target is illegal as a processing instruction name.

方法详细资料

setTarget

public ProcessingInstruction setTarget(java.lang.String newTarget)

This will set the target for the PI.

参数:

newTarget - String new target of PI.

返回:

ProcessingInstruction - this PI modified.

getValue

public java.lang.String getValue()

Returns the XPath 1.0 string value of this element, which is the data of this PI.

指定者:

getValue 在类中 Content

返回:

the data of this PI

getTarget

public java.lang.String getTarget()

This will retrieve the target of the PI.

返回:

String - target of PI.

getData

public java.lang.String getData()

This will return the raw data from all instructions.

返回:

String - data of PI.

getPseudoAttributeNames

public java.util.List<java.lang.String> getPseudoAttributeNames()

This will return a List containing the names of the "attribute" style pieces of name/value pairs in this PI's data.

返回:

List - the List containing the "attribute" names.

setData

public ProcessingInstruction setData(java.lang.String data)

This will set the raw data for the PI.

参数:

data - String data of PI.

返回:

ProcessingInstruction - this PI modified.

setData

public ProcessingInstruction setData(java.util.Map<java.lang.String,java.lang.String> data)

This will set the name/value pairs within the passed Map as the pairs for the data of this PI. The keys should be the pair name and the values should be the pair values.

参数:

data - new map data to use

返回:

ProcessingInstruction - modified PI.

getPseudoAttributeValue

public java.lang.String getPseudoAttributeValue(java.lang.String name)

This will return the value for a specific name/value pair on the PI. If no such pair is found for this PI, null is returned.

参数:

name - String name of name/value pair to lookup value for.

返回:

String - value of name/value pair.

setPseudoAttribute

public ProcessingInstruction setPseudoAttribute(java.lang.String name,
                                                java.lang.String value)

This will set a pseudo attribute with the given name and value. If the PI data is not already in a pseudo-attribute format, this will replace the existing data.

参数:

name - String name of pair.

value - String value for pair.

返回:

ProcessingInstruction this PI modified.

removePseudoAttribute

public boolean removePseudoAttribute(java.lang.String name)

This will remove the pseudo attribute with the specified name.

参数:

name - name of pseudo attribute to remove

返回:

boolean - whether the requested instruction was removed.

toString

public java.lang.String toString()

This returns a String representation of the ProcessingInstruction, suitable for debugging. If the XML representation of the ProcessingInstruction is desired, XMLOutputter.outputString(ProcessingInstruction) should be used.

覆盖:

toString 在类中 java.lang.Object

返回:

String - information about the ProcessingInstruction

clone

public ProcessingInstruction clone()

Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not.

All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return vaue).

Subclasses of this should still call super.clone() in their clone method.

覆盖:

clone 在类中 Content

detach

public ProcessingInstruction detach()

从类复制的说明: Content

Detaches this child from its parent or does nothing if the child has no parent.

This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call super.detach();

覆盖:

detach 在类中 Content

返回:

this child detached