org.mitre.cybox.objects.NetworkSubnet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of stix Show documentation
Show all versions of stix Show documentation
The Java bindings for STIX v.1.2.0.2
/**
* Copyright (c) 2015, The MITRE Corporation. All rights reserved.
* See LICENSE for complete terms.
*/
//
// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.2.5-2
// See http://java.sun.com/xml/jaxb
// Any modifications to this file will be lost upon recompilation of the source schema.
// Generated on: 2015.07.01 at 03:30:29 PM EDT
//
package org.mitre.cybox.objects;
import java.io.StringReader;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import javax.xml.namespace.QName;
import javax.xml.transform.stream.StreamSource;
import org.jvnet.jaxb2_commons.lang.Equals;
import org.jvnet.jaxb2_commons.lang.EqualsStrategy;
import org.jvnet.jaxb2_commons.lang.HashCode;
import org.jvnet.jaxb2_commons.lang.HashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBEqualsStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBHashCodeStrategy;
import org.jvnet.jaxb2_commons.lang.JAXBToStringStrategy;
import org.jvnet.jaxb2_commons.lang.ToString;
import org.jvnet.jaxb2_commons.lang.ToStringStrategy;
import org.jvnet.jaxb2_commons.locator.ObjectLocator;
import org.jvnet.jaxb2_commons.locator.util.LocatorUtils;
import org.mitre.cybox.common_2.CustomPropertiesType;
import org.mitre.cybox.common_2.IntegerObjectPropertyType;
import org.mitre.cybox.common_2.ObjectPropertiesType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.common_2.StructuredTextType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The NetworkSubnetObjectType type is intended to characterize a generic system network subnet.
*
* Java class for NetworkSubnetObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="NetworkSubnetObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <element name="Name" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* <element name="Description" type="{http://cybox.mitre.org/common-2}StructuredTextType" minOccurs="0"/>
* <element name="Number_Of_IP_Addresses" type="{http://cybox.mitre.org/common-2}IntegerObjectPropertyType" minOccurs="0"/>
* <element name="Routes" type="{http://cybox.mitre.org/objects#NetworkSubnetObject-2}RoutesType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "NetworkSubnetObjectType", namespace = "http://cybox.mitre.org/objects#NetworkSubnetObject-2", propOrder = {
"name", "description", "numberOfIPAddresses", "routes" })
@XmlRootElement(name = "Network_Subnet", namespace = "http://cybox.mitre.org/objects#NetworkSubnetObject-2")
public class NetworkSubnet extends ObjectPropertiesType implements Equals,
HashCode, ToString {
@XmlElement(name = "Name")
protected StringObjectPropertyType name;
@XmlElement(name = "Description")
protected StructuredTextType description;
@XmlElement(name = "Number_Of_IP_Addresses")
protected IntegerObjectPropertyType numberOfIPAddresses;
@XmlElement(name = "Routes")
protected RoutesType routes;
/**
* Default no-arg constructor
*
*/
public NetworkSubnet() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public NetworkSubnet(final CustomPropertiesType customProperties,
final QName objectReference, final StringObjectPropertyType name,
final StructuredTextType description,
final IntegerObjectPropertyType numberOfIPAddresses,
final RoutesType routes) {
super(customProperties, objectReference);
this.name = name;
this.description = description;
this.numberOfIPAddresses = numberOfIPAddresses;
this.routes = routes;
}
/**
* Gets the value of the name property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setName(StringObjectPropertyType value) {
this.name = value;
}
/**
* Gets the value of the description property.
*
* @return
* possible object is
* {@link StructuredTextType }
*
*/
public StructuredTextType getDescription() {
return description;
}
/**
* Sets the value of the description property.
*
* @param value
* allowed object is
* {@link StructuredTextType }
*
*/
public void setDescription(StructuredTextType value) {
this.description = value;
}
/**
* Gets the value of the numberOfIPAddresses property.
*
* @return
* possible object is
* {@link IntegerObjectPropertyType }
*
*/
public IntegerObjectPropertyType getNumberOfIPAddresses() {
return numberOfIPAddresses;
}
/**
* Sets the value of the numberOfIPAddresses property.
*
* @param value
* allowed object is
* {@link IntegerObjectPropertyType }
*
*/
public void setNumberOfIPAddresses(IntegerObjectPropertyType value) {
this.numberOfIPAddresses = value;
}
/**
* Gets the value of the routes property.
*
* @return
* possible object is
* {@link RoutesType }
*
*/
public RoutesType getRoutes() {
return routes;
}
/**
* Sets the value of the routes property.
*
* @param value
* allowed object is
* {@link RoutesType }
*
*/
public void setRoutes(RoutesType value) {
this.routes = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof NetworkSubnet)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final NetworkSubnet that = ((NetworkSubnet) object);
{
StringObjectPropertyType lhsName;
lhsName = this.getName();
StringObjectPropertyType rhsName;
rhsName = that.getName();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "name", lhsName),
LocatorUtils.property(thatLocator, "name", rhsName),
lhsName, rhsName)) {
return false;
}
}
{
StructuredTextType lhsDescription;
lhsDescription = this.getDescription();
StructuredTextType rhsDescription;
rhsDescription = that.getDescription();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"description", lhsDescription), LocatorUtils.property(
thatLocator, "description", rhsDescription),
lhsDescription, rhsDescription)) {
return false;
}
}
{
IntegerObjectPropertyType lhsNumberOfIPAddresses;
lhsNumberOfIPAddresses = this.getNumberOfIPAddresses();
IntegerObjectPropertyType rhsNumberOfIPAddresses;
rhsNumberOfIPAddresses = that.getNumberOfIPAddresses();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"numberOfIPAddresses", lhsNumberOfIPAddresses),
LocatorUtils.property(thatLocator, "numberOfIPAddresses",
rhsNumberOfIPAddresses), lhsNumberOfIPAddresses,
rhsNumberOfIPAddresses)) {
return false;
}
}
{
RoutesType lhsRoutes;
lhsRoutes = this.getRoutes();
RoutesType rhsRoutes;
rhsRoutes = that.getRoutes();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "routes", lhsRoutes),
LocatorUtils.property(thatLocator, "routes", rhsRoutes),
lhsRoutes, rhsRoutes)) {
return false;
}
}
return true;
}
public boolean equals(Object object) {
final EqualsStrategy strategy = JAXBEqualsStrategy.INSTANCE;
return equals(null, null, object, strategy);
}
public int hashCode(ObjectLocator locator, HashCodeStrategy strategy) {
int currentHashCode = super.hashCode(locator, strategy);
{
StringObjectPropertyType theName;
theName = this.getName();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "name", theName),
currentHashCode, theName);
}
{
StructuredTextType theDescription;
theDescription = this.getDescription();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"description", theDescription), currentHashCode,
theDescription);
}
{
IntegerObjectPropertyType theNumberOfIPAddresses;
theNumberOfIPAddresses = this.getNumberOfIPAddresses();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"numberOfIPAddresses", theNumberOfIPAddresses),
currentHashCode, theNumberOfIPAddresses);
}
{
RoutesType theRoutes;
theRoutes = this.getRoutes();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "routes", theRoutes),
currentHashCode, theRoutes);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public NetworkSubnet withName(StringObjectPropertyType value) {
setName(value);
return this;
}
public NetworkSubnet withDescription(StructuredTextType value) {
setDescription(value);
return this;
}
public NetworkSubnet withNumberOfIPAddresses(IntegerObjectPropertyType value) {
setNumberOfIPAddresses(value);
return this;
}
public NetworkSubnet withRoutes(RoutesType value) {
setRoutes(value);
return this;
}
@Override
public NetworkSubnet withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public NetworkSubnet withObjectReference(QName value) {
setObjectReference(value);
return this;
}
public String toString() {
final ToStringStrategy strategy = JAXBToStringStrategy.INSTANCE;
final StringBuilder buffer = new StringBuilder();
append(null, buffer, strategy);
return buffer.toString();
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
ToStringStrategy strategy) {
strategy.appendStart(locator, this, buffer);
appendFields(locator, buffer, strategy);
strategy.appendEnd(locator, this, buffer);
return buffer;
}
public StringBuilder appendFields(ObjectLocator locator,
StringBuilder buffer, ToStringStrategy strategy) {
super.appendFields(locator, buffer, strategy);
{
StringObjectPropertyType theName;
theName = this.getName();
strategy.appendField(locator, this, "name", buffer, theName);
}
{
StructuredTextType theDescription;
theDescription = this.getDescription();
strategy.appendField(locator, this, "description", buffer,
theDescription);
}
{
IntegerObjectPropertyType theNumberOfIPAddresses;
theNumberOfIPAddresses = this.getNumberOfIPAddresses();
strategy.appendField(locator, this, "numberOfIPAddresses", buffer,
theNumberOfIPAddresses);
}
{
RoutesType theRoutes;
theRoutes = this.getRoutes();
strategy.appendField(locator, this, "routes", buffer, theRoutes);
}
return buffer;
}
/**
* Returns A Document representation of this instance that is not formatted.
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument() {
return toDocument(false);
}
/**
* Returns A Document representation for this instance.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The Document representation for this instance.
*/
public org.w3c.dom.Document toDocument(boolean prettyPrint) {
return DocumentUtilities.toDocument(toJAXBElement(), prettyPrint);
}
/**
* Returns JAXBElement for this instance.
*
* @return The JAXBElement for this instance.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public JAXBElement toJAXBElement() {
QName qualifiedName = STIXSchema.getQualifiedName(this);
return new JAXBElement(qualifiedName, NetworkSubnet.class, this);
}
/**
* Returns String representation of this instance that is not formatted.
*
* @return The String containing the XML mark-up.
*/
public String toXMLString() {
return toXMLString(false);
}
/**
* Returns XML String for JAXB Document Object Model object.
*
* @param prettyPrint
* True for pretty print, otherwise false
*
* @return The String containing the XML mark-up.
*/
public String toXMLString(boolean prettyPrint) {
return DocumentUtilities.toXMLString(toDocument(), prettyPrint);
}
/**
* Creates NetworkSubnet instance for XML String
*
* @param text
* XML String for the document
* @return The NetworkSubnet instance for the passed XML String
*/
public static NetworkSubnet fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(NetworkSubnet.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (NetworkSubnet) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this NetworkSubnet instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean True If it validates against the schema
* @throws SAXException
* If the a validation ErrorHandler has not been set, and
* validation throws a SAXException
*/
public boolean validate() throws SAXException {
return STIXSchema.getInstance().validate(toXMLString());
}
}