org.mitre.cybox.objects.WindowsFilemapping Maven / Gradle / Ivy
Show all versions of stix Show documentation
/**
* 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:19:53 PM EDT
//
package org.mitre.cybox.objects;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
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.ObjectPropertiesType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.common_2.UnsignedLongObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The WindowsFilemappingObjectType type is intended to characterize Windows file mapping objects.
*
* Java class for WindowsFilemappingObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="WindowsFilemappingObjectType">
* <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="File_Handle" type="{http://cybox.mitre.org/objects#WinHandleObject-2}WindowsHandleObjectType" minOccurs="0"/>
* <element name="Handle" type="{http://cybox.mitre.org/objects#WinHandleObject-2}WindowsHandleObjectType" minOccurs="0"/>
* <element name="Page_Protection_Value" type="{http://cybox.mitre.org/objects#WinFilemappingObject-1}PageProtectionValueType" minOccurs="0"/>
* <element name="Page_Protection_Attribute" type="{http://cybox.mitre.org/objects#WinFilemappingObject-1}PageProtectionAttributeType" maxOccurs="unbounded" minOccurs="0"/>
* <element name="Maximum_Size" type="{http://cybox.mitre.org/common-2}UnsignedLongObjectPropertyType" minOccurs="0"/>
* <element name="Actual_Size" type="{http://cybox.mitre.org/common-2}UnsignedLongObjectPropertyType" 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 = "WindowsFilemappingObjectType", namespace = "http://cybox.mitre.org/objects#WinFilemappingObject-1", propOrder = {
"name", "fileHandle", "handle", "pageProtectionValue",
"pageProtectionAttributes", "maximumSize", "actualSize",
"securityAttributes" })
@XmlRootElement(name = "Windows_Filemapping", namespace = "http://cybox.mitre.org/objects#WinFilemappingObject-1")
public class WindowsFilemapping extends ObjectPropertiesType implements Equals,
HashCode, ToString {
@XmlElement(name = "Name")
protected StringObjectPropertyType name;
@XmlElement(name = "File_Handle")
protected WindowsHandle fileHandle;
@XmlElement(name = "Handle")
protected WindowsHandle handle;
@XmlElement(name = "Page_Protection_Value")
protected PageProtectionValueType pageProtectionValue;
@XmlElement(name = "Page_Protection_Attribute")
protected List pageProtectionAttributes;
@XmlElement(name = "Maximum_Size")
protected UnsignedLongObjectPropertyType maximumSize;
@XmlElement(name = "Actual_Size")
protected UnsignedLongObjectPropertyType actualSize;
@XmlElement(name = "Security_Attributes")
protected StringObjectPropertyType securityAttributes;
/**
* Default no-arg constructor
*
*/
public WindowsFilemapping() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public WindowsFilemapping(final CustomPropertiesType customProperties,
final QName objectReference, final StringObjectPropertyType name,
final WindowsHandle fileHandle, final WindowsHandle handle,
final PageProtectionValueType pageProtectionValue,
final List pageProtectionAttributes,
final UnsignedLongObjectPropertyType maximumSize,
final UnsignedLongObjectPropertyType actualSize,
final StringObjectPropertyType securityAttributes) {
super(customProperties, objectReference);
this.name = name;
this.fileHandle = fileHandle;
this.handle = handle;
this.pageProtectionValue = pageProtectionValue;
this.pageProtectionAttributes = pageProtectionAttributes;
this.maximumSize = maximumSize;
this.actualSize = actualSize;
this.securityAttributes = securityAttributes;
}
/**
* 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 fileHandle property.
*
* @return
* possible object is
* {@link WindowsHandle }
*
*/
public WindowsHandle getFileHandle() {
return fileHandle;
}
/**
* Sets the value of the fileHandle property.
*
* @param value
* allowed object is
* {@link WindowsHandle }
*
*/
public void setFileHandle(WindowsHandle value) {
this.fileHandle = 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 pageProtectionValue property.
*
* @return
* possible object is
* {@link PageProtectionValueType }
*
*/
public PageProtectionValueType getPageProtectionValue() {
return pageProtectionValue;
}
/**
* Sets the value of the pageProtectionValue property.
*
* @param value
* allowed object is
* {@link PageProtectionValueType }
*
*/
public void setPageProtectionValue(PageProtectionValueType value) {
this.pageProtectionValue = value;
}
/**
* Gets the value of the pageProtectionAttributes property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the pageProtectionAttributes property.
*
*
* For example, to add a new item, do as follows:
*
* getPageProtectionAttributes().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PageProtectionAttributeType }
*
*
*/
public List getPageProtectionAttributes() {
if (pageProtectionAttributes == null) {
pageProtectionAttributes = new ArrayList();
}
return this.pageProtectionAttributes;
}
/**
* Gets the value of the maximumSize property.
*
* @return
* possible object is
* {@link UnsignedLongObjectPropertyType }
*
*/
public UnsignedLongObjectPropertyType getMaximumSize() {
return maximumSize;
}
/**
* Sets the value of the maximumSize property.
*
* @param value
* allowed object is
* {@link UnsignedLongObjectPropertyType }
*
*/
public void setMaximumSize(UnsignedLongObjectPropertyType value) {
this.maximumSize = value;
}
/**
* Gets the value of the actualSize property.
*
* @return
* possible object is
* {@link UnsignedLongObjectPropertyType }
*
*/
public UnsignedLongObjectPropertyType getActualSize() {
return actualSize;
}
/**
* Sets the value of the actualSize property.
*
* @param value
* allowed object is
* {@link UnsignedLongObjectPropertyType }
*
*/
public void setActualSize(UnsignedLongObjectPropertyType value) {
this.actualSize = 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 WindowsFilemapping)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final WindowsFilemapping that = ((WindowsFilemapping) 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;
}
}
{
WindowsHandle lhsFileHandle;
lhsFileHandle = this.getFileHandle();
WindowsHandle rhsFileHandle;
rhsFileHandle = that.getFileHandle();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"fileHandle", lhsFileHandle), LocatorUtils.property(
thatLocator, "fileHandle", rhsFileHandle), lhsFileHandle,
rhsFileHandle)) {
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;
}
}
{
PageProtectionValueType lhsPageProtectionValue;
lhsPageProtectionValue = this.getPageProtectionValue();
PageProtectionValueType rhsPageProtectionValue;
rhsPageProtectionValue = that.getPageProtectionValue();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"pageProtectionValue", lhsPageProtectionValue),
LocatorUtils.property(thatLocator, "pageProtectionValue",
rhsPageProtectionValue), lhsPageProtectionValue,
rhsPageProtectionValue)) {
return false;
}
}
{
List lhsPageProtectionAttributes;
lhsPageProtectionAttributes = (((this.pageProtectionAttributes != null) && (!this.pageProtectionAttributes
.isEmpty())) ? this.getPageProtectionAttributes() : null);
List rhsPageProtectionAttributes;
rhsPageProtectionAttributes = (((that.pageProtectionAttributes != null) && (!that.pageProtectionAttributes
.isEmpty())) ? that.getPageProtectionAttributes() : null);
if (!strategy.equals(LocatorUtils.property(thisLocator,
"pageProtectionAttributes", lhsPageProtectionAttributes),
LocatorUtils.property(thatLocator,
"pageProtectionAttributes",
rhsPageProtectionAttributes),
lhsPageProtectionAttributes, rhsPageProtectionAttributes)) {
return false;
}
}
{
UnsignedLongObjectPropertyType lhsMaximumSize;
lhsMaximumSize = this.getMaximumSize();
UnsignedLongObjectPropertyType rhsMaximumSize;
rhsMaximumSize = that.getMaximumSize();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"maximumSize", lhsMaximumSize), LocatorUtils.property(
thatLocator, "maximumSize", rhsMaximumSize),
lhsMaximumSize, rhsMaximumSize)) {
return false;
}
}
{
UnsignedLongObjectPropertyType lhsActualSize;
lhsActualSize = this.getActualSize();
UnsignedLongObjectPropertyType rhsActualSize;
rhsActualSize = that.getActualSize();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"actualSize", lhsActualSize), LocatorUtils.property(
thatLocator, "actualSize", rhsActualSize), lhsActualSize,
rhsActualSize)) {
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);
{
StringObjectPropertyType theName;
theName = this.getName();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "name", theName),
currentHashCode, theName);
}
{
WindowsHandle theFileHandle;
theFileHandle = this.getFileHandle();
currentHashCode = strategy
.hashCode(LocatorUtils.property(locator, "fileHandle",
theFileHandle), currentHashCode, theFileHandle);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "handle", theHandle),
currentHashCode, theHandle);
}
{
PageProtectionValueType thePageProtectionValue;
thePageProtectionValue = this.getPageProtectionValue();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"pageProtectionValue", thePageProtectionValue),
currentHashCode, thePageProtectionValue);
}
{
List thePageProtectionAttributes;
thePageProtectionAttributes = (((this.pageProtectionAttributes != null) && (!this.pageProtectionAttributes
.isEmpty())) ? this.getPageProtectionAttributes() : null);
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"pageProtectionAttributes", thePageProtectionAttributes),
currentHashCode, thePageProtectionAttributes);
}
{
UnsignedLongObjectPropertyType theMaximumSize;
theMaximumSize = this.getMaximumSize();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"maximumSize", theMaximumSize), currentHashCode,
theMaximumSize);
}
{
UnsignedLongObjectPropertyType theActualSize;
theActualSize = this.getActualSize();
currentHashCode = strategy
.hashCode(LocatorUtils.property(locator, "actualSize",
theActualSize), currentHashCode, theActualSize);
}
{
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 WindowsFilemapping withName(StringObjectPropertyType value) {
setName(value);
return this;
}
public WindowsFilemapping withFileHandle(WindowsHandle value) {
setFileHandle(value);
return this;
}
public WindowsFilemapping withHandle(WindowsHandle value) {
setHandle(value);
return this;
}
public WindowsFilemapping withPageProtectionValue(
PageProtectionValueType value) {
setPageProtectionValue(value);
return this;
}
public WindowsFilemapping withPageProtectionAttributes(
PageProtectionAttributeType... values) {
if (values != null) {
for (PageProtectionAttributeType value : values) {
getPageProtectionAttributes().add(value);
}
}
return this;
}
public WindowsFilemapping withPageProtectionAttributes(
Collection values) {
if (values != null) {
getPageProtectionAttributes().addAll(values);
}
return this;
}
public WindowsFilemapping withMaximumSize(
UnsignedLongObjectPropertyType value) {
setMaximumSize(value);
return this;
}
public WindowsFilemapping withActualSize(
UnsignedLongObjectPropertyType value) {
setActualSize(value);
return this;
}
public WindowsFilemapping withSecurityAttributes(
StringObjectPropertyType value) {
setSecurityAttributes(value);
return this;
}
@Override
public WindowsFilemapping withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public WindowsFilemapping 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);
}
{
WindowsHandle theFileHandle;
theFileHandle = this.getFileHandle();
strategy.appendField(locator, this, "fileHandle", buffer,
theFileHandle);
}
{
WindowsHandle theHandle;
theHandle = this.getHandle();
strategy.appendField(locator, this, "handle", buffer, theHandle);
}
{
PageProtectionValueType thePageProtectionValue;
thePageProtectionValue = this.getPageProtectionValue();
strategy.appendField(locator, this, "pageProtectionValue", buffer,
thePageProtectionValue);
}
{
List thePageProtectionAttributes;
thePageProtectionAttributes = (((this.pageProtectionAttributes != null) && (!this.pageProtectionAttributes
.isEmpty())) ? this.getPageProtectionAttributes() : null);
strategy.appendField(locator, this, "pageProtectionAttributes",
buffer, thePageProtectionAttributes);
}
{
UnsignedLongObjectPropertyType theMaximumSize;
theMaximumSize = this.getMaximumSize();
strategy.appendField(locator, this, "maximumSize", buffer,
theMaximumSize);
}
{
UnsignedLongObjectPropertyType theActualSize;
theActualSize = this.getActualSize();
strategy.appendField(locator, this, "actualSize", buffer,
theActualSize);
}
{
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, WindowsFilemapping.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 WindowsFilemapping instance for XML String
*
* @param text
* XML String for the document
* @return The WindowsFilemapping instance for the passed XML String
*/
public static WindowsFilemapping fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(WindowsFilemapping.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (WindowsFilemapping) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this WindowsFilemapping 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());
}
}