org.mitre.cybox.common_2.Property 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.06.23 at 10:59:44 AM EDT
//
package org.mitre.cybox.common_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.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;
/**
* The PropertyType is a type representing the specification of a single Object Property.
*
* Java class for PropertyType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="PropertyType">
* <simpleContent>
* <extension base="<http://cybox.mitre.org/common-2>BaseObjectPropertyType">
* <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
* </extension>
* </simpleContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "PropertyType")
@XmlRootElement(name = "Property", namespace = "http://cybox.mitre.org/cybox-2")
public class Property extends BaseObjectPropertyType implements Equals,
HashCode, ToString {
@XmlAttribute(name = "name")
protected String name;
@XmlAttribute(name = "description")
protected String description;
/**
* Default no-arg constructor
*
*/
public Property() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public Property(final Object value, final ConditionTypeEnum condition,
final Boolean isCaseSensitive,
final ConditionApplicationEnum applyCondition,
final String delimiter, final byte[] bitMask,
final PatternTypeEnum patternType, final String regexSyntax,
final Boolean hasChanged, final Boolean trend, final QName id,
final QName idref, final DatatypeEnum datatype,
final Boolean appearsRandom, final Boolean isObfuscated,
final String obfuscationAlgorithmRef, final Boolean isDefanged,
final String defangingAlgorithmRef,
final String refangingTransformType,
final String refangingTransform, final String observedEncoding,
final String name, final String description) {
super(value, condition, isCaseSensitive, applyCondition, delimiter,
bitMask, patternType, regexSyntax, hasChanged, trend, id,
idref, datatype, appearsRandom, isObfuscated,
obfuscationAlgorithmRef, isDefanged, defangingAlgorithmRef,
refangingTransformType, refangingTransform, observedEncoding);
this.name = name;
this.description = description;
}
/**
* Gets the value of the name property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getName() {
return name;
}
/**
* Sets the value of the name property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setName(String value) {
this.name = value;
}
/**
* Gets the value of the description property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getDescription() {
return description;
}
/**
* Sets the value of the description property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setDescription(String value) {
this.description = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof Property)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final Property that = ((Property) object);
{
String lhsName;
lhsName = this.getName();
String rhsName;
rhsName = that.getName();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "name", lhsName),
LocatorUtils.property(thatLocator, "name", rhsName),
lhsName, rhsName)) {
return false;
}
}
{
String lhsDescription;
lhsDescription = this.getDescription();
String rhsDescription;
rhsDescription = that.getDescription();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"description", lhsDescription), LocatorUtils.property(
thatLocator, "description", rhsDescription),
lhsDescription, rhsDescription)) {
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);
{
String theName;
theName = this.getName();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "name", theName),
currentHashCode, theName);
}
{
String theDescription;
theDescription = this.getDescription();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"description", theDescription), currentHashCode,
theDescription);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public Property withName(String value) {
setName(value);
return this;
}
public Property withDescription(String value) {
setDescription(value);
return this;
}
@Override
public Property withValue(Object value) {
setValue(value);
return this;
}
@Override
public Property withCondition(ConditionTypeEnum value) {
setCondition(value);
return this;
}
@Override
public Property withIsCaseSensitive(Boolean value) {
setIsCaseSensitive(value);
return this;
}
@Override
public Property withApplyCondition(ConditionApplicationEnum value) {
setApplyCondition(value);
return this;
}
@Override
public Property withDelimiter(String value) {
setDelimiter(value);
return this;
}
@Override
public Property withBitMask(byte[] value) {
setBitMask(value);
return this;
}
@Override
public Property withPatternType(PatternTypeEnum value) {
setPatternType(value);
return this;
}
@Override
public Property withRegexSyntax(String value) {
setRegexSyntax(value);
return this;
}
@Override
public Property withHasChanged(Boolean value) {
setHasChanged(value);
return this;
}
@Override
public Property withTrend(Boolean value) {
setTrend(value);
return this;
}
@Override
public Property withId(QName value) {
setId(value);
return this;
}
@Override
public Property withIdref(QName value) {
setIdref(value);
return this;
}
@Override
public Property withDatatype(DatatypeEnum value) {
setDatatype(value);
return this;
}
@Override
public Property withAppearsRandom(Boolean value) {
setAppearsRandom(value);
return this;
}
@Override
public Property withIsObfuscated(Boolean value) {
setIsObfuscated(value);
return this;
}
@Override
public Property withObfuscationAlgorithmRef(String value) {
setObfuscationAlgorithmRef(value);
return this;
}
@Override
public Property withIsDefanged(Boolean value) {
setIsDefanged(value);
return this;
}
@Override
public Property withDefangingAlgorithmRef(String value) {
setDefangingAlgorithmRef(value);
return this;
}
@Override
public Property withRefangingTransformType(String value) {
setRefangingTransformType(value);
return this;
}
@Override
public Property withRefangingTransform(String value) {
setRefangingTransform(value);
return this;
}
@Override
public Property withObservedEncoding(String value) {
setObservedEncoding(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);
{
String theName;
theName = this.getName();
strategy.appendField(locator, this, "name", buffer, theName);
}
{
String theDescription;
theDescription = this.getDescription();
strategy.appendField(locator, this, "description", buffer,
theDescription);
}
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, Property.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 Property instance for XML String
*
* @param text
* XML String for the document
* @return The Property instance for the passed XML String
*/
public static Property fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(Property.class.getPackage()
.getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (Property) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this Property instance
* Returning true indicating a successful validation, false if not.
*
* @return boolean
*/
public boolean validate() {
return STIXSchema.getInstance().validate(toXMLString());
}
}