org.mitre.cybox.objects.Port 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.Layer4ProtocolType;
import org.mitre.cybox.common_2.ObjectPropertiesType;
import org.mitre.cybox.common_2.PositiveIntegerObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The PortObjectType type is intended to characterize networking ports.
*
* Java class for PortObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="PortObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <element name="Port_Value" type="{http://cybox.mitre.org/common-2}PositiveIntegerObjectPropertyType" minOccurs="0"/>
* <element name="Layer4_Protocol" type="{http://cybox.mitre.org/common-2}Layer4ProtocolType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "PortObjectType", namespace = "http://cybox.mitre.org/objects#PortObject-2", propOrder = {
"portValue", "layer4Protocol" })
@XmlRootElement(name = "Port", namespace = "http://cybox.mitre.org/objects#PortObject-2")
public class Port extends ObjectPropertiesType implements Equals, HashCode,
ToString {
@XmlElement(name = "Port_Value")
protected PositiveIntegerObjectPropertyType portValue;
@XmlElement(name = "Layer4_Protocol")
protected Layer4ProtocolType layer4Protocol;
/**
* Default no-arg constructor
*
*/
public Port() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Port(final CustomPropertiesType customProperties,
final QName objectReference,
final PositiveIntegerObjectPropertyType portValue,
final Layer4ProtocolType layer4Protocol) {
super(customProperties, objectReference);
this.portValue = portValue;
this.layer4Protocol = layer4Protocol;
}
/**
* Gets the value of the portValue property.
*
* @return
* possible object is
* {@link PositiveIntegerObjectPropertyType }
*
*/
public PositiveIntegerObjectPropertyType getPortValue() {
return portValue;
}
/**
* Sets the value of the portValue property.
*
* @param value
* allowed object is
* {@link PositiveIntegerObjectPropertyType }
*
*/
public void setPortValue(PositiveIntegerObjectPropertyType value) {
this.portValue = value;
}
/**
* Gets the value of the layer4Protocol property.
*
* @return
* possible object is
* {@link Layer4ProtocolType }
*
*/
public Layer4ProtocolType getLayer4Protocol() {
return layer4Protocol;
}
/**
* Sets the value of the layer4Protocol property.
*
* @param value
* allowed object is
* {@link Layer4ProtocolType }
*
*/
public void setLayer4Protocol(Layer4ProtocolType value) {
this.layer4Protocol = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof Port)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final Port that = ((Port) object);
{
PositiveIntegerObjectPropertyType lhsPortValue;
lhsPortValue = this.getPortValue();
PositiveIntegerObjectPropertyType rhsPortValue;
rhsPortValue = that.getPortValue();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"portValue", lhsPortValue), LocatorUtils.property(
thatLocator, "portValue", rhsPortValue), lhsPortValue,
rhsPortValue)) {
return false;
}
}
{
Layer4ProtocolType lhsLayer4Protocol;
lhsLayer4Protocol = this.getLayer4Protocol();
Layer4ProtocolType rhsLayer4Protocol;
rhsLayer4Protocol = that.getLayer4Protocol();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"layer4Protocol", lhsLayer4Protocol),
LocatorUtils.property(thatLocator, "layer4Protocol",
rhsLayer4Protocol), lhsLayer4Protocol,
rhsLayer4Protocol)) {
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);
{
PositiveIntegerObjectPropertyType thePortValue;
thePortValue = this.getPortValue();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "portValue", thePortValue),
currentHashCode, thePortValue);
}
{
Layer4ProtocolType theLayer4Protocol;
theLayer4Protocol = this.getLayer4Protocol();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"layer4Protocol", theLayer4Protocol), currentHashCode,
theLayer4Protocol);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public Port withPortValue(PositiveIntegerObjectPropertyType value) {
setPortValue(value);
return this;
}
public Port withLayer4Protocol(Layer4ProtocolType value) {
setLayer4Protocol(value);
return this;
}
@Override
public Port withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public Port 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);
{
PositiveIntegerObjectPropertyType thePortValue;
thePortValue = this.getPortValue();
strategy.appendField(locator, this, "portValue", buffer,
thePortValue);
}
{
Layer4ProtocolType theLayer4Protocol;
theLayer4Protocol = this.getLayer4Protocol();
strategy.appendField(locator, this, "layer4Protocol", buffer,
theLayer4Protocol);
}
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, Port.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 Port instance for XML String
*
* @param text
* XML String for the document
* @return The Port instance for the passed XML String
*/
public static Port fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(Port.class.getPackage()
.getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (Port) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this Port 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());
}
}