org.xmlsoap.schemas.soap.envelope

Class Envelope

java.lang.Object

org.xmlsoap.schemas.soap.envelope.Envelope

public class Envelope
extends Object

Java class for Envelope complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Envelope">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://schemas.xmlsoap.org/soap/envelope/}Header" minOccurs="0"/>
         <element ref="{http://schemas.xmlsoap.org/soap/envelope/}Body"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <anyAttribute processContents='lax' namespace='##other'/>
     </restriction>
   </complexContent>
 </complexType>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Envelope.Builder<_B>
static class	Envelope.Select
static class	Envelope.Selector<TRoot extends com.kscs.util.jaxb.Selector<TRoot,?>,TParent>

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	any
protected Body	body
protected Header	header

Constructor Summary

Constructors

Constructor and Description
Envelope()

Method Summary

Modifier and Type	Method and Description
static Envelope.Builder<Void>	builder()
static Envelope.Builder<Void>	copyExcept(Envelope _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
static <_B> Envelope.Builder<_B>	copyOf(Envelope _other)
static <_B> Envelope.Builder<_B>	copyOf(Envelope _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
static Envelope.Builder<Void>	copyOnly(Envelope _other, com.kscs.util.jaxb.PropertyTree _propertyTree)
<_B> void	copyTo(Envelope.Builder<_B> _other) Copies all state of this object to a builder.
<_B> void	copyTo(Envelope.Builder<_B> _other, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse) Copies all state of this object to a builder.
List<Object>	getAny() Gets the value of the any property.
Body	getBody() Gets the value of the body property.
Header	getHeader() Gets the value of the header property.
Map<QName,String>	getOtherAttributes() Gets a map that contains attributes that aren't bound to any typed property on this class.
<_B> Envelope.Builder<_B>	newCopyBuilder(_B _parentBuilder)
<_B> Envelope.Builder<_B>	newCopyBuilder(_B _parentBuilder, com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
Envelope.Builder<Void>	newCopyBuilder()
Envelope.Builder<Void>	newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree, com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)
void	setBody(Body value) Sets the value of the body property.
void	setHeader(Header value) Sets the value of the header property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

header

protected Header header

body

protected Body body

any

protected List<Object> any

Constructor Detail

Envelope

public Envelope()

Method Detail

getHeader

public Header getHeader()

Gets the value of the header property.

Returns:

possible object is Header

setHeader

public void setHeader(Header value)

Sets the value of the header property.

Parameters:

value - allowed object is Header

getBody

public Body getBody()

Gets the value of the body property.

Returns:

possible object is Body

setBody

public void setBody(Body value)

Sets the value of the body property.

Parameters:

value - allowed object is Body

getAny

public List<Object> getAny()

Gets the value of the any property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

For example, to add a new item, do as follows:

    getAny().add(newItem);
 

Objects of the following type(s) are allowed in the list Object Element

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Gets a map that contains attributes that aren't bound to any typed property on this class.

the map is keyed by the name of the attribute and the value is the string value of the attribute. the map returned by this method is live, and you can add new attribute by updating the map directly. Because of this design, there's no setter.

Returns:

always non-null

copyTo

public <_B> void copyTo(Envelope.Builder<_B> _other)

Copies all state of this object to a builder. This method is used by the copyOf(org.xmlsoap.schemas.soap.envelope.Envelope) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> Envelope.Builder<_B> newCopyBuilder(_B _parentBuilder)

newCopyBuilder

public Envelope.Builder<Void> newCopyBuilder()

builder

public static Envelope.Builder<Void> builder()

copyOf

public static <_B> Envelope.Builder<_B> copyOf(Envelope _other)

copyTo

public <_B> void copyTo(Envelope.Builder<_B> _other,
                        com.kscs.util.jaxb.PropertyTree _propertyTree,
                        com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

Copies all state of this object to a builder. This method is used by the copyOf(org.xmlsoap.schemas.soap.envelope.Envelope) method and should not be called directly by client code.

Parameters:

_other - A builder instance to which the state of this object will be copied.

newCopyBuilder

public <_B> Envelope.Builder<_B> newCopyBuilder(_B _parentBuilder,
                                                com.kscs.util.jaxb.PropertyTree _propertyTree,
                                                com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

newCopyBuilder

public Envelope.Builder<Void> newCopyBuilder(com.kscs.util.jaxb.PropertyTree _propertyTree,
                                             com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyOf

public static <_B> Envelope.Builder<_B> copyOf(Envelope _other,
                                               com.kscs.util.jaxb.PropertyTree _propertyTree,
                                               com.kscs.util.jaxb.PropertyTreeUse _propertyTreeUse)

copyExcept

public static Envelope.Builder<Void> copyExcept(Envelope _other,
                                                com.kscs.util.jaxb.PropertyTree _propertyTree)

copyOnly

public static Envelope.Builder<Void> copyOnly(Envelope _other,
                                              com.kscs.util.jaxb.PropertyTree _propertyTree)