org.mitre.capec.capec_2.Environment 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
The newest version!
/**
* 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.capec.capec_2;
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.XmlID;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.CollapsedStringAdapter;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
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;
import org.xml.sax.SAXException;
/**
* Description and globally unique ID for a kind of environment or
* context that is required. Used in Attack Steps, Indicators of Susceptibility,
* and Security Controls, etc.
*
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <all>
* <element name="Environment_Title" type="{http://www.w3.org/2001/XMLSchema}token"/>
* <element name="Environment_Description" type="{http://www.w3.org/2001/XMLSchema}token"/>
* </all>
* <attribute name="ID" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
})
@XmlRootElement(name = "Environment")
public class Environment implements Equals, HashCode, ToString {
@XmlElement(name = "Environment_Title", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "token")
protected String environmentTitle;
@XmlElement(name = "Environment_Description", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlSchemaType(name = "token")
protected String environmentDescription;
@XmlAttribute(name = "ID", required = true)
@XmlJavaTypeAdapter(CollapsedStringAdapter.class)
@XmlID
@XmlSchemaType(name = "ID")
protected String id;
/**
* Default no-arg constructor
*
*/
public Environment() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Environment(final String environmentTitle,
final String environmentDescription, final String id) {
this.environmentTitle = environmentTitle;
this.environmentDescription = environmentDescription;
this.id = id;
}
/**
* Gets the value of the environmentTitle property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getEnvironmentTitle() {
return environmentTitle;
}
/**
* Sets the value of the environmentTitle property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setEnvironmentTitle(String value) {
this.environmentTitle = value;
}
/**
* Gets the value of the environmentDescription property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getEnvironmentDescription() {
return environmentDescription;
}
/**
* Sets the value of the environmentDescription property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setEnvironmentDescription(String value) {
this.environmentDescription = 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 Environment)) {
return false;
}
if (this == object) {
return true;
}
final Environment that = ((Environment) object);
{
String lhsEnvironmentTitle;
lhsEnvironmentTitle = this.getEnvironmentTitle();
String rhsEnvironmentTitle;
rhsEnvironmentTitle = that.getEnvironmentTitle();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"environmentTitle", lhsEnvironmentTitle), LocatorUtils
.property(thatLocator, "environmentTitle",
rhsEnvironmentTitle), lhsEnvironmentTitle,
rhsEnvironmentTitle)) {
return false;
}
}
{
String lhsEnvironmentDescription;
lhsEnvironmentDescription = this.getEnvironmentDescription();
String rhsEnvironmentDescription;
rhsEnvironmentDescription = that.getEnvironmentDescription();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"environmentDescription", lhsEnvironmentDescription),
LocatorUtils
.property(thatLocator, "environmentDescription",
rhsEnvironmentDescription),
lhsEnvironmentDescription, rhsEnvironmentDescription)) {
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;
{
String theEnvironmentTitle;
theEnvironmentTitle = this.getEnvironmentTitle();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"environmentTitle", theEnvironmentTitle), currentHashCode,
theEnvironmentTitle);
}
{
String theEnvironmentDescription;
theEnvironmentDescription = this.getEnvironmentDescription();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"environmentDescription", theEnvironmentDescription),
currentHashCode, theEnvironmentDescription);
}
{
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 Environment withEnvironmentTitle(String value) {
setEnvironmentTitle(value);
return this;
}
public Environment withEnvironmentDescription(String value) {
setEnvironmentDescription(value);
return this;
}
public Environment 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) {
{
String theEnvironmentTitle;
theEnvironmentTitle = this.getEnvironmentTitle();
strategy.appendField(locator, this, "environmentTitle", buffer,
theEnvironmentTitle);
}
{
String theEnvironmentDescription;
theEnvironmentDescription = this.getEnvironmentDescription();
strategy.appendField(locator, this, "environmentDescription",
buffer, theEnvironmentDescription);
}
{
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, Environment.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 Environment instance for XML String
*
* @param text
* XML String for the document
* @return The Environment instance for the passed XML String
*/
public static Environment fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(Environment.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (Environment) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this Environment 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());
}
}