org.mitre.cpe.language._2.LogicalTest 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:30:29 PM EDT
//
package org.mitre.cpe.language._2;
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.XmlAttribute;
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.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The logical-test element appears as a child of a
* platform element, and may also be nested to create more complex logical
* tests. The content consists of one or more elements: fact-ref, and
* logical-test children are permitted. The operator to be applied, and
* optional negation of the test, are given as attributes.
*
* Java class for LogicalTestType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="LogicalTestType">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="logical-test" type="{http://cpe.mitre.org/language/2.0}LogicalTestType" maxOccurs="unbounded" minOccurs="0"/>
* <element ref="{http://cpe.mitre.org/language/2.0}fact-ref" maxOccurs="unbounded" minOccurs="0"/>
* </sequence>
* <attribute name="operator" use="required" type="{http://cpe.mitre.org/language/2.0}operatorEnumeration" />
* <attribute name="negate" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "LogicalTestType", propOrder = { "logicalTests", "factReves" })
@XmlRootElement(name = "logical-test")
public class LogicalTest implements Equals, HashCode, ToString {
@XmlElement(name = "logical-test")
protected List logicalTests;
@XmlElement(name = "fact-ref")
protected List factReves;
@XmlAttribute(name = "operator", required = true)
protected OperatorEnumeration operator;
@XmlAttribute(name = "negate", required = true)
protected boolean negate;
/**
* Default no-arg constructor
*
*/
public LogicalTest() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public LogicalTest(final List logicalTests,
final List factReves, final OperatorEnumeration operator,
final boolean negate) {
this.logicalTests = logicalTests;
this.factReves = factReves;
this.operator = operator;
this.negate = negate;
}
/**
* Gets the value of the logicalTests 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 logicalTests property.
*
*
* For example, to add a new item, do as follows:
*
* getLogicalTests().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link LogicalTest }
*
*
*/
public List getLogicalTests() {
if (logicalTests == null) {
logicalTests = new ArrayList();
}
return this.logicalTests;
}
/**
* Gets the value of the factReves 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 factReves property.
*
*
* For example, to add a new item, do as follows:
*
* getFactReves().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link FactRef }
*
*
*/
public List getFactReves() {
if (factReves == null) {
factReves = new ArrayList();
}
return this.factReves;
}
/**
* Gets the value of the operator property.
*
* @return
* possible object is
* {@link OperatorEnumeration }
*
*/
public OperatorEnumeration getOperator() {
return operator;
}
/**
* Sets the value of the operator property.
*
* @param value
* allowed object is
* {@link OperatorEnumeration }
*
*/
public void setOperator(OperatorEnumeration value) {
this.operator = value;
}
/**
* Gets the value of the negate property.
*
*/
public boolean isNegate() {
return negate;
}
/**
* Sets the value of the negate property.
*
*/
public void setNegate(boolean value) {
this.negate = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof LogicalTest)) {
return false;
}
if (this == object) {
return true;
}
final LogicalTest that = ((LogicalTest) object);
{
List lhsLogicalTests;
lhsLogicalTests = (((this.logicalTests != null) && (!this.logicalTests
.isEmpty())) ? this.getLogicalTests() : null);
List rhsLogicalTests;
rhsLogicalTests = (((that.logicalTests != null) && (!that.logicalTests
.isEmpty())) ? that.getLogicalTests() : null);
if (!strategy.equals(LocatorUtils.property(thisLocator,
"logicalTests", lhsLogicalTests), LocatorUtils.property(
thatLocator, "logicalTests", rhsLogicalTests),
lhsLogicalTests, rhsLogicalTests)) {
return false;
}
}
{
List lhsFactReves;
lhsFactReves = (((this.factReves != null) && (!this.factReves
.isEmpty())) ? this.getFactReves() : null);
List rhsFactReves;
rhsFactReves = (((that.factReves != null) && (!that.factReves
.isEmpty())) ? that.getFactReves() : null);
if (!strategy.equals(LocatorUtils.property(thisLocator,
"factReves", lhsFactReves), LocatorUtils.property(
thatLocator, "factReves", rhsFactReves), lhsFactReves,
rhsFactReves)) {
return false;
}
}
{
OperatorEnumeration lhsOperator;
lhsOperator = this.getOperator();
OperatorEnumeration rhsOperator;
rhsOperator = that.getOperator();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "operator",
lhsOperator), LocatorUtils.property(thatLocator,
"operator", rhsOperator), lhsOperator, rhsOperator)) {
return false;
}
}
{
boolean lhsNegate;
lhsNegate = (true ? this.isNegate() : false);
boolean rhsNegate;
rhsNegate = (true ? that.isNegate() : false);
if (!strategy.equals(
LocatorUtils.property(thisLocator, "negate", lhsNegate),
LocatorUtils.property(thatLocator, "negate", rhsNegate),
lhsNegate, rhsNegate)) {
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;
{
List theLogicalTests;
theLogicalTests = (((this.logicalTests != null) && (!this.logicalTests
.isEmpty())) ? this.getLogicalTests() : null);
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"logicalTests", theLogicalTests), currentHashCode,
theLogicalTests);
}
{
List theFactReves;
theFactReves = (((this.factReves != null) && (!this.factReves
.isEmpty())) ? this.getFactReves() : null);
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "factReves", theFactReves),
currentHashCode, theFactReves);
}
{
OperatorEnumeration theOperator;
theOperator = this.getOperator();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "operator", theOperator),
currentHashCode, theOperator);
}
{
boolean theNegate;
theNegate = (true ? this.isNegate() : false);
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "negate", theNegate),
currentHashCode, theNegate);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public LogicalTest withLogicalTests(LogicalTest... values) {
if (values != null) {
for (LogicalTest value : values) {
getLogicalTests().add(value);
}
}
return this;
}
public LogicalTest withLogicalTests(Collection values) {
if (values != null) {
getLogicalTests().addAll(values);
}
return this;
}
public LogicalTest withFactReves(FactRef... values) {
if (values != null) {
for (FactRef value : values) {
getFactReves().add(value);
}
}
return this;
}
public LogicalTest withFactReves(Collection values) {
if (values != null) {
getFactReves().addAll(values);
}
return this;
}
public LogicalTest withOperator(OperatorEnumeration value) {
setOperator(value);
return this;
}
public LogicalTest withNegate(boolean value) {
setNegate(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) {
{
List theLogicalTests;
theLogicalTests = (((this.logicalTests != null) && (!this.logicalTests
.isEmpty())) ? this.getLogicalTests() : null);
strategy.appendField(locator, this, "logicalTests", buffer,
theLogicalTests);
}
{
List theFactReves;
theFactReves = (((this.factReves != null) && (!this.factReves
.isEmpty())) ? this.getFactReves() : null);
strategy.appendField(locator, this, "factReves", buffer,
theFactReves);
}
{
OperatorEnumeration theOperator;
theOperator = this.getOperator();
strategy.appendField(locator, this, "operator", buffer, theOperator);
}
{
boolean theNegate;
theNegate = (true ? this.isNegate() : false);
strategy.appendField(locator, this, "negate", buffer, theNegate);
}
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, LogicalTest.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 LogicalTest instance for XML String
*
* @param text
* XML String for the document
* @return The LogicalTest instance for the passed XML String
*/
public static LogicalTest fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(LogicalTest.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (LogicalTest) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this LogicalTest 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());
}
}