org.mitre.cybox.objects.WindowsPipe 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.HexBinaryObjectPropertyType;
import org.mitre.cybox.common_2.NonNegativeIntegerObjectPropertyType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The WindowsPipeObjectType type is intended to characterize Windows pipes.
*
* Java class for WindowsPipeObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="WindowsPipeObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/objects#PipeObject-2}PipeObjectType">
* <sequence>
* <element name="Default_Time_Out" type="{http://cybox.mitre.org/common-2}NonNegativeIntegerObjectPropertyType" minOccurs="0"/>
* <element name="Handle" type="{http://cybox.mitre.org/objects#WinHandleObject-2}WindowsHandleObjectType" minOccurs="0"/>
* <element name="In_Buffer_Size" type="{http://cybox.mitre.org/common-2}NonNegativeIntegerObjectPropertyType" minOccurs="0"/>
* <element name="Max_Instances" type="{http://cybox.mitre.org/common-2}NonNegativeIntegerObjectPropertyType" minOccurs="0"/>
* <element name="Open_Mode" type="{http://cybox.mitre.org/common-2}HexBinaryObjectPropertyType" minOccurs="0"/>
* <element name="Out_Buffer_Size" type="{http://cybox.mitre.org/common-2}NonNegativeIntegerObjectPropertyType" minOccurs="0" form="qualified"/>
* <element name="Pipe_Mode" type="{http://cybox.mitre.org/common-2}HexBinaryObjectPropertyType" minOccurs="0"/>
* <element name="Security_Attributes" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "WindowsPipeObjectType", namespace = "http://cybox.mitre.org/objects#WinPipeObject-2", propOrder = {
"defaultTimeOut", "handle", "inBufferSize", "maxInstances", "openMode",
"outBufferSize", "pipeMode", "securityAttributes" })
@XmlRootElement(name = "Windows_Pipe", namespace = "http://cybox.mitre.org/objects#WinPipeObject-2")
public class WindowsPipe extends PipeObjectType implements Equals, HashCode,
ToString {
@XmlElement(name = "Default_Time_Out")
protected NonNegativeIntegerObjectPropertyType defaultTimeOut;
@XmlElement(name = "Handle")
protected WindowsHandle handle;
@XmlElement(name = "In_Buffer_Size")
protected NonNegativeIntegerObjectPropertyType inBufferSize;
@XmlElement(name = "Max_Instances")
protected NonNegativeIntegerObjectPropertyType maxInstances;
@XmlElement(name = "Open_Mode")
protected HexBinaryObjectPropertyType openMode;
@XmlElement(name = "Out_Buffer_Size")
protected NonNegativeIntegerObjectPropertyType outBufferSize;
@XmlElement(name = "Pipe_Mode")
protected HexBinaryObjectPropertyType pipeMode;
@XmlElement(name = "Security_Attributes")
protected StringObjectPropertyType securityAttributes;
/**
* Default no-arg constructor
*
*/
public WindowsPipe() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public WindowsPipe(final CustomPropertiesType customProperties,
final QName objectReference, final StringObjectPropertyType name,
final Boolean named,
final NonNegativeIntegerObjectPropertyType defaultTimeOut,
final WindowsHandle handle,
final NonNegativeIntegerObjectPropertyType inBufferSize,
final NonNegativeIntegerObjectPropertyType maxInstances,
final HexBinaryObjectPropertyType openMode,
final NonNegativeIntegerObjectPropertyType outBufferSize,
final HexBinaryObjectPropertyType pipeMode,
final StringObjectPropertyType securityAttributes) {
super(customProperties, objectReference, name, named);
this.defaultTimeOut = defaultTimeOut;
this.handle = handle;
this.inBufferSize = inBufferSize;
this.maxInstances = maxInstances;
this.openMode = openMode;
this.outBufferSize = outBufferSize;
this.pipeMode = pipeMode;
this.securityAttributes = securityAttributes;
}
/**
* Gets the value of the defaultTimeOut property.
*
* @return
* possible object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public NonNegativeIntegerObjectPropertyType getDefaultTimeOut() {
return defaultTimeOut;
}
/**
* Sets the value of the defaultTimeOut property.
*
* @param value
* allowed object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public void setDefaultTimeOut(NonNegativeIntegerObjectPropertyType value) {
this.defaultTimeOut = value;
}
/**
* Gets the value of the handle property.
*
* @return
* possible object is
* {@link WindowsHandle }
*
*/
public WindowsHandle getHandle() {
return handle;
}
/**
* Sets the value of the handle property.
*
* @param value
* allowed object is
* {@link WindowsHandle }
*
*/
public void setHandle(WindowsHandle value) {
this.handle = value;
}
/**
* Gets the value of the inBufferSize property.
*
* @return
* possible object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public NonNegativeIntegerObjectPropertyType getInBufferSize() {
return inBufferSize;
}
/**
* Sets the value of the inBufferSize property.
*
* @param value
* allowed object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public void setInBufferSize(NonNegativeIntegerObjectPropertyType value) {
this.inBufferSize = value;
}
/**
* Gets the value of the maxInstances property.
*
* @return
* possible object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public NonNegativeIntegerObjectPropertyType getMaxInstances() {
return maxInstances;
}
/**
* Sets the value of the maxInstances property.
*
* @param value
* allowed object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public void setMaxInstances(NonNegativeIntegerObjectPropertyType value) {
this.maxInstances = value;
}
/**
* Gets the value of the openMode property.
*
* @return
* possible object is
* {@link HexBinaryObjectPropertyType }
*
*/
public HexBinaryObjectPropertyType getOpenMode() {
return openMode;
}
/**
* Sets the value of the openMode property.
*
* @param value
* allowed object is
* {@link HexBinaryObjectPropertyType }
*
*/
public void setOpenMode(HexBinaryObjectPropertyType value) {
this.openMode = value;
}
/**
* Gets the value of the outBufferSize property.
*
* @return
* possible object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public NonNegativeIntegerObjectPropertyType getOutBufferSize() {
return outBufferSize;
}
/**
* Sets the value of the outBufferSize property.
*
* @param value
* allowed object is
* {@link NonNegativeIntegerObjectPropertyType }
*
*/
public void setOutBufferSize(NonNegativeIntegerObjectPropertyType value) {
this.outBufferSize = value;
}
/**
* Gets the value of the pipeMode property.
*
* @return
* possible object is
* {@link HexBinaryObjectPropertyType }
*
*/
public HexBinaryObjectPropertyType getPipeMode() {
return pipeMode;
}
/**
* Sets the value of the pipeMode property.
*
* @param value
* allowed object is
* {@link HexBinaryObjectPropertyType }
*
*/
public void setPipeMode(HexBinaryObjectPropertyType value) {
this.pipeMode = value;
}
/**
* Gets the value of the securityAttributes property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getSecurityAttributes() {
return securityAttributes;
}
/**
* Sets the value of the securityAttributes property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setSecurityAttributes(StringObjectPropertyType value) {
this.securityAttributes = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof WindowsPipe)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final WindowsPipe that = ((WindowsPipe) object);
{
NonNegativeIntegerObjectPropertyType lhsDefaultTimeOut;
lhsDefaultTimeOut = this.getDefaultTimeOut();
NonNegativeIntegerObjectPropertyType rhsDefaultTimeOut;
rhsDefaultTimeOut = that.getDefaultTimeOut();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"defaultTimeOut", lhsDefaultTimeOut),
LocatorUtils.property(thatLocator, "defaultTimeOut",
rhsDefaultTimeOut), lhsDefaultTimeOut,
rhsDefaultTimeOut)) {
return false;
}
}
{
WindowsHandle lhsHandle;
lhsHandle = this.getHandle();
WindowsHandle rhsHandle;
rhsHandle = that.getHandle();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "handle", lhsHandle),
LocatorUtils.property(thatLocator, "handle", rhsHandle),
lhsHandle, rhsHandle)) {
return false;
}
}
{
NonNegativeIntegerObjectPropertyType lhsInBufferSize;
lhsInBufferSize = this.getInBufferSize();
NonNegativeIntegerObjectPropertyType rhsInBufferSize;
rhsInBufferSize = that.getInBufferSize();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"inBufferSize", lhsInBufferSize), LocatorUtils.property(
thatLocator, "inBufferSize", rhsInBufferSize),
lhsInBufferSize, rhsInBufferSize)) {
return false;
}
}
{
NonNegativeIntegerObjectPropertyType lhsMaxInstances;
lhsMaxInstances = this.getMaxInstances();
NonNegativeIntegerObjectPropertyType rhsMaxInstances;
rhsMaxInstances = that.getMaxInstances();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"maxInstances", lhsMaxInstances), LocatorUtils.property(
thatLocator, "maxInstances", rhsMaxInstances),
lhsMaxInstances, rhsMaxInstances)) {
return false;
}
}
{
HexBinaryObjectPropertyType lhsOpenMode;
lhsOpenMode = this.getOpenMode();
HexBinaryObjectPropertyType rhsOpenMode;
rhsOpenMode = that.getOpenMode();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "openMode",
lhsOpenMode), LocatorUtils.property(thatLocator,
"openMode", rhsOpenMode), lhsOpenMode, rhsOpenMode)) {
return false;
}
}
{
NonNegativeIntegerObjectPropertyType lhsOutBufferSize;
lhsOutBufferSize = this.getOutBufferSize();
NonNegativeIntegerObjectPropertyType rhsOutBufferSize;
rhsOutBufferSize = that.getOutBufferSize();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"outBufferSize", lhsOutBufferSize), LocatorUtils.property(
thatLocator, "outBufferSize", rhsOutBufferSize),
lhsOutBufferSize, rhsOutBufferSize)) {
return false;
}
}
{
HexBinaryObjectPropertyType lhsPipeMode;
lhsPipeMode = this.getPipeMode();
HexBinaryObjectPropertyType rhsPipeMode;
rhsPipeMode = that.getPipeMode();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "pipeMode",
lhsPipeMode), LocatorUtils.property(thatLocator,
"pipeMode", rhsPipeMode), lhsPipeMode, rhsPipeMode)) {
return false;
}
}
{
StringObjectPropertyType lhsSecurityAttributes;
lhsSecurityAttributes = this.getSecurityAttributes();
StringObjectPropertyType rhsSecurityAttributes;
rhsSecurityAttributes = that.getSecurityAttributes();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"securityAttributes", lhsSecurityAttributes), LocatorUtils
.property(thatLocator, "securityAttributes",
rhsSecurityAttributes), lhsSecurityAttributes,
rhsSecurityAttributes)) {
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);
{
NonNegativeIntegerObjectPropertyType theDefaultTimeOut;
theDefaultTimeOut = this.getDefaultTimeOut();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"defaultTimeOut", theDefaultTimeOut), currentHashCode,
theDefaultTimeOut);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "handle", theHandle),
currentHashCode, theHandle);
}
{
NonNegativeIntegerObjectPropertyType theInBufferSize;
theInBufferSize = this.getInBufferSize();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"inBufferSize", theInBufferSize), currentHashCode,
theInBufferSize);
}
{
NonNegativeIntegerObjectPropertyType theMaxInstances;
theMaxInstances = this.getMaxInstances();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"maxInstances", theMaxInstances), currentHashCode,
theMaxInstances);
}
{
HexBinaryObjectPropertyType theOpenMode;
theOpenMode = this.getOpenMode();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "openMode", theOpenMode),
currentHashCode, theOpenMode);
}
{
NonNegativeIntegerObjectPropertyType theOutBufferSize;
theOutBufferSize = this.getOutBufferSize();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"outBufferSize", theOutBufferSize), currentHashCode,
theOutBufferSize);
}
{
HexBinaryObjectPropertyType thePipeMode;
thePipeMode = this.getPipeMode();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "pipeMode", thePipeMode),
currentHashCode, thePipeMode);
}
{
StringObjectPropertyType theSecurityAttributes;
theSecurityAttributes = this.getSecurityAttributes();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"securityAttributes", theSecurityAttributes),
currentHashCode, theSecurityAttributes);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public WindowsPipe withDefaultTimeOut(
NonNegativeIntegerObjectPropertyType value) {
setDefaultTimeOut(value);
return this;
}
public WindowsPipe withHandle(WindowsHandle value) {
setHandle(value);
return this;
}
public WindowsPipe withInBufferSize(
NonNegativeIntegerObjectPropertyType value) {
setInBufferSize(value);
return this;
}
public WindowsPipe withMaxInstances(
NonNegativeIntegerObjectPropertyType value) {
setMaxInstances(value);
return this;
}
public WindowsPipe withOpenMode(HexBinaryObjectPropertyType value) {
setOpenMode(value);
return this;
}
public WindowsPipe withOutBufferSize(
NonNegativeIntegerObjectPropertyType value) {
setOutBufferSize(value);
return this;
}
public WindowsPipe withPipeMode(HexBinaryObjectPropertyType value) {
setPipeMode(value);
return this;
}
public WindowsPipe withSecurityAttributes(StringObjectPropertyType value) {
setSecurityAttributes(value);
return this;
}
@Override
public WindowsPipe withName(StringObjectPropertyType value) {
setName(value);
return this;
}
@Override
public WindowsPipe withNamed(Boolean value) {
setNamed(value);
return this;
}
@Override
public WindowsPipe withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public WindowsPipe 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);
{
NonNegativeIntegerObjectPropertyType theDefaultTimeOut;
theDefaultTimeOut = this.getDefaultTimeOut();
strategy.appendField(locator, this, "defaultTimeOut", buffer,
theDefaultTimeOut);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
strategy.appendField(locator, this, "handle", buffer, theHandle);
}
{
NonNegativeIntegerObjectPropertyType theInBufferSize;
theInBufferSize = this.getInBufferSize();
strategy.appendField(locator, this, "inBufferSize", buffer,
theInBufferSize);
}
{
NonNegativeIntegerObjectPropertyType theMaxInstances;
theMaxInstances = this.getMaxInstances();
strategy.appendField(locator, this, "maxInstances", buffer,
theMaxInstances);
}
{
HexBinaryObjectPropertyType theOpenMode;
theOpenMode = this.getOpenMode();
strategy.appendField(locator, this, "openMode", buffer, theOpenMode);
}
{
NonNegativeIntegerObjectPropertyType theOutBufferSize;
theOutBufferSize = this.getOutBufferSize();
strategy.appendField(locator, this, "outBufferSize", buffer,
theOutBufferSize);
}
{
HexBinaryObjectPropertyType thePipeMode;
thePipeMode = this.getPipeMode();
strategy.appendField(locator, this, "pipeMode", buffer, thePipeMode);
}
{
StringObjectPropertyType theSecurityAttributes;
theSecurityAttributes = this.getSecurityAttributes();
strategy.appendField(locator, this, "securityAttributes", buffer,
theSecurityAttributes);
}
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, WindowsPipe.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 WindowsPipe instance for XML String
*
* @param text
* XML String for the document
* @return The WindowsPipe instance for the passed XML String
*/
public static WindowsPipe fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(WindowsPipe.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (WindowsPipe) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this WindowsPipe 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());
}
}