xml.metadatasharing.IPObject 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.06.23 at 10:59:44 AM EDT
//
package xml.metadatasharing;
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.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
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.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
/**
*
* IP object. Used to hold ipv4, ipv6 ip addresses and address ranges. The globally unique id is 'startAddress-endAddress'.
*
* There are two required elements, startAddress and endAddress, make these the same if you are
* specifying a single address.
*
* Thus for ip range id, would be e.g. 213.23.45.7-213.23.45.19
* For a single ip, id would be e.g. 12.34.56.1-12.34.56.1
*
*
*
* Java class for IPObject complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="IPObject">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="startAddress" type="{http://xml/metadataSharing.xsd}IPAddress"/>
* <element name="endAddress" type="{http://xml/metadataSharing.xsd}IPAddress"/>
* </sequence>
* <attribute name="id" use="required" type="{http://xml/metadataSharing.xsd}IPRange" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "IPObject", propOrder = { "startAddress", "endAddress" })
public class IPObject implements Equals, HashCode, ToString {
@XmlElement(required = true)
protected IPAddress startAddress;
@XmlElement(required = true)
protected IPAddress endAddress;
@XmlAttribute(name = "id", required = true)
protected String id;
/**
* Default no-arg constructor
*
*/
public IPObject() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public IPObject(final IPAddress startAddress, final IPAddress endAddress,
final String id) {
this.startAddress = startAddress;
this.endAddress = endAddress;
this.id = id;
}
/**
* Gets the value of the startAddress property.
*
* @return
* possible object is
* {@link IPAddress }
*
*/
public IPAddress getStartAddress() {
return startAddress;
}
/**
* Sets the value of the startAddress property.
*
* @param value
* allowed object is
* {@link IPAddress }
*
*/
public void setStartAddress(IPAddress value) {
this.startAddress = value;
}
/**
* Gets the value of the endAddress property.
*
* @return
* possible object is
* {@link IPAddress }
*
*/
public IPAddress getEndAddress() {
return endAddress;
}
/**
* Sets the value of the endAddress property.
*
* @param value
* allowed object is
* {@link IPAddress }
*
*/
public void setEndAddress(IPAddress value) {
this.endAddress = value;
}
/**
* Gets the value of the id property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getId() {
return id;
}
/**
* Sets the value of the id property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setId(String value) {
this.id = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof IPObject)) {
return false;
}
if (this == object) {
return true;
}
final IPObject that = ((IPObject) object);
{
IPAddress lhsStartAddress;
lhsStartAddress = this.getStartAddress();
IPAddress rhsStartAddress;
rhsStartAddress = that.getStartAddress();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"startAddress", lhsStartAddress), LocatorUtils.property(
thatLocator, "startAddress", rhsStartAddress),
lhsStartAddress, rhsStartAddress)) {
return false;
}
}
{
IPAddress lhsEndAddress;
lhsEndAddress = this.getEndAddress();
IPAddress rhsEndAddress;
rhsEndAddress = that.getEndAddress();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"endAddress", lhsEndAddress), LocatorUtils.property(
thatLocator, "endAddress", rhsEndAddress), lhsEndAddress,
rhsEndAddress)) {
return false;
}
}
{
String lhsId;
lhsId = this.getId();
String rhsId;
rhsId = that.getId();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "id", lhsId),
LocatorUtils.property(thatLocator, "id", rhsId), lhsId,
rhsId)) {
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 = 1;
{
IPAddress theStartAddress;
theStartAddress = this.getStartAddress();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"startAddress", theStartAddress), currentHashCode,
theStartAddress);
}
{
IPAddress theEndAddress;
theEndAddress = this.getEndAddress();
currentHashCode = strategy
.hashCode(LocatorUtils.property(locator, "endAddress",
theEndAddress), currentHashCode, theEndAddress);
}
{
String theId;
theId = this.getId();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "id", theId),
currentHashCode, theId);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public IPObject withStartAddress(IPAddress value) {
setStartAddress(value);
return this;
}
public IPObject withEndAddress(IPAddress value) {
setEndAddress(value);
return this;
}
public IPObject withId(String value) {
setId(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) {
{
IPAddress theStartAddress;
theStartAddress = this.getStartAddress();
strategy.appendField(locator, this, "startAddress", buffer,
theStartAddress);
}
{
IPAddress theEndAddress;
theEndAddress = this.getEndAddress();
strategy.appendField(locator, this, "endAddress", buffer,
theEndAddress);
}
{
String theId;
theId = this.getId();
strategy.appendField(locator, this, "id", buffer, theId);
}
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, IPObject.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 IPObject instance for XML String
*
* @param text
* XML String for the document
* @return The IPObject instance for the passed XML String
*/
public static IPObject fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(IPObject.class.getPackage()
.getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (IPObject) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this IPObject instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean
*/
public boolean validate() {
return STIXSchema.getInstance().validate(toXMLString());
}
}