VirtualCoverage (DDMSence 2.6.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.summary.VirtualCoverage

All Implemented Interfaces:: IDDMSComponent

public final class VirtualCoverage
extends AbstractBaseComponent

An immutable implementation of ddms:virtualCoverage.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
The network and protocol attributes moved into the virt namespace in DDMS 5.0.

Nested Elements

Name

Cardinality

Availability

None.

Attributes

Name

Cardinality

Availability

ddms:address

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

virt:address

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:protocol

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

virt:protocol

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

virt:network

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:access

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:<securityAttributes>

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Validation Rules

Rule

Type

Applicability

The qualified name of this element must be correct.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If the address attribute is present, the protocol attribute must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

virt:network must not be used before the DDMS version in which it was introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:access must not be used before the DDMS version in which it was introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Security attributes must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

This component can be used with no values set.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Since:: 0.9.b
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VirtualCoverage.Builder
Builder for this DDMS component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`VirtualCoverage.Builder` Builder for this DDMS component.

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

Constructor Summary

Constructors
Constructor and Description
`VirtualCoverage(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`VirtualCoverage(String address, String protocol, SecurityAttributes securityAttributes)` Deprecated. A new constructor was added for DDMS 5.0 to support ntk:access and virt:network. This constructor is preserved for backwards compatibility, but may disappear in the next major release.
`VirtualCoverage(String address, String protocol, String access, String network, SecurityAttributes securityAttributes)` Constructor for creating a component from raw data

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`String`	`getAccess()` Accessor for the access attribute
`String`	`getAddress()` Accessor for the address attribute
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`com.google.gson.JsonObject`	`getJSONObject()` Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
`static String`	`getName(DDMSVersion version)` Accessor for the element name of this component, based on the version of DDMS used
`String`	`getNetwork()` Accessor for the network attribute
`String`	`getProtocol()` Accessor for the protocol attribute (optional, should be used if address is supplied)
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`int`	`hashCode()` Returns a hashcode for the component.
`protected void`	`validate()` Base case for validation.
`protected void`	`validateWarnings()` Base case for warnings.

Methods inherited from class buri.ddmsence.AbstractBaseComponent
addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VirtualCoverage
```
public VirtualCoverage(nu.xom.Element element)
                throws InvalidDDMSException
```
    Constructor for creating a component from a XOM Element
    
    Parameters:
    
    element - the XOM element representing this
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - VirtualCoverage
```
public VirtualCoverage(String address,
                       String protocol,
                       SecurityAttributes securityAttributes)
                throws InvalidDDMSException
```
    Deprecated. A new constructor was added for DDMS 5.0 to support ntk:access and virt:network. This constructor is preserved for backwards compatibility, but may disappear in the next major release.
    
    Constructor for creating a component from raw data
    
    Parameters:
    
    address - the virtual address
    
    protocol - the network protocol
    
    securityAttributes - any security attributes
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - VirtualCoverage
```
public VirtualCoverage(String address,
                       String protocol,
                       String access,
                       String network,
                       SecurityAttributes securityAttributes)
                throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    
    address - the virtual address
    
    protocol - the network protocol
    
    access - an NTK portion access pattern
    
    network - a VIRT network name
    
    securityAttributes - any security attributes
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
- Method Detail
  - validate
```
protected void validate()
                 throws InvalidDDMSException
```
    Description copied from class: AbstractBaseComponent
    
    Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validate in class AbstractBaseComponent
    
    Throws:
    
    InvalidDDMSException
    
    See Also:
    
    AbstractBaseComponent.validate()
  - validateWarnings
```
protected void validateWarnings()
```
    Description copied from class: AbstractBaseComponent
    
    Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.validateWarnings()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.
    
    Specified by:
    
    getJSONObject in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getJSONObject()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as HTML or Text, with an optional prefix to nest it.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.
    
    Specified by:
    
    getHTMLTextOutput in class AbstractBaseComponent
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - an optional prefix to put on each name.
    
    suffix - an optional suffix to append to each name, such as an index.
    
    Returns:
    
    the representation of this component in the specified format
    
    See Also:
    
    AbstractBaseComponent.getHTMLTextOutput(OutputFormat, String, String)
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: AbstractBaseComponent
    
    Test for logical equality.
    The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.
    
    Overrides:
    
    equals in class AbstractBaseComponent
    
    See Also:
    
    Object.equals(Object)
  - hashCode
```
public int hashCode()
```
    Description copied from class: AbstractBaseComponent
    
    Returns a hashcode for the component.
    This automatically includes any nested components or security attributes.
    
    Overrides:
    
    hashCode in class AbstractBaseComponent
    
    See Also:
    
    Object.hashCode()
  - getName
```
public static String getName(DDMSVersion version)
```
    Accessor for the element name of this component, based on the version of DDMS used
    
    Parameters:
    
    version - the DDMSVersion
    
    Returns:
    
    an element name
  - getAddress
```
public String getAddress()
```
    Accessor for the address attribute
  - getProtocol
```
public String getProtocol()
```
    Accessor for the protocol attribute (optional, should be used if address is supplied)
  - getAccess
```
public String getAccess()
```
    Accessor for the access attribute
  - getNetwork
```
public String getNetwork()
```
    Accessor for the network attribute
  - getSecurityAttributes
```
public SecurityAttributes getSecurityAttributes()
```
    Accessor for the Security Attributes. Will always be non-null, even if it has no values set.
    
    Specified by:
    
    getSecurityAttributes in interface IDDMSComponent
    
    Overrides:
    
    getSecurityAttributes in class AbstractBaseComponent

Class VirtualCoverage

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

VirtualCoverage

VirtualCoverage

VirtualCoverage

Method Detail

validate

validateWarnings

getJSONObject

getHTMLTextOutput

equals

hashCode

getName

getAddress

getProtocol

getAccess

getNetwork

getSecurityAttributes