org.mitre.cybox.objects.API 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.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.ObjectPropertiesType;
import org.mitre.cybox.common_2.PlatformSpecificationType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.cybox.common_2.StructuredTextType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The APIObjectType type is intended to characterize a specific Application Programming Interface.
*
* Java class for APIObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="APIObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <element name="Description" type="{http://cybox.mitre.org/common-2}StructuredTextType" minOccurs="0"/>
* <element name="Function_Name" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* <element name="Normalized_Function_Name" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* <element name="Platform" type="{http://cybox.mitre.org/common-2}PlatformSpecificationType" minOccurs="0"/>
* <element name="Address" type="{http://cybox.mitre.org/common-2}HexBinaryObjectPropertyType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "APIObjectType", namespace = "http://cybox.mitre.org/objects#APIObject-2", propOrder = {
"description", "functionName", "normalizedFunctionName", "platform",
"address" })
@XmlRootElement(name = "API", namespace = "http://cybox.mitre.org/objects#APIObject-2")
public class API extends ObjectPropertiesType implements Equals, HashCode,
ToString {
@XmlElement(name = "Description")
protected StructuredTextType description;
@XmlElement(name = "Function_Name")
protected StringObjectPropertyType functionName;
@XmlElement(name = "Normalized_Function_Name")
protected StringObjectPropertyType normalizedFunctionName;
@XmlElement(name = "Platform")
protected PlatformSpecificationType platform;
@XmlElement(name = "Address")
protected HexBinaryObjectPropertyType address;
/**
* Default no-arg constructor
*
*/
public API() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public API(final CustomPropertiesType customProperties,
final QName objectReference, final StructuredTextType description,
final StringObjectPropertyType functionName,
final StringObjectPropertyType normalizedFunctionName,
final PlatformSpecificationType platform,
final HexBinaryObjectPropertyType address) {
super(customProperties, objectReference);
this.description = description;
this.functionName = functionName;
this.normalizedFunctionName = normalizedFunctionName;
this.platform = platform;
this.address = address;
}
/**
* Gets the value of the description property.
*
* @return
* possible object is
* {@link StructuredTextType }
*
*/
public StructuredTextType getDescription() {
return description;
}
/**
* Sets the value of the description property.
*
* @param value
* allowed object is
* {@link StructuredTextType }
*
*/
public void setDescription(StructuredTextType value) {
this.description = value;
}
/**
* Gets the value of the functionName property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getFunctionName() {
return functionName;
}
/**
* Sets the value of the functionName property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setFunctionName(StringObjectPropertyType value) {
this.functionName = value;
}
/**
* Gets the value of the normalizedFunctionName property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getNormalizedFunctionName() {
return normalizedFunctionName;
}
/**
* Sets the value of the normalizedFunctionName property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setNormalizedFunctionName(StringObjectPropertyType value) {
this.normalizedFunctionName = value;
}
/**
* Gets the value of the platform property.
*
* @return
* possible object is
* {@link PlatformSpecificationType }
*
*/
public PlatformSpecificationType getPlatform() {
return platform;
}
/**
* Sets the value of the platform property.
*
* @param value
* allowed object is
* {@link PlatformSpecificationType }
*
*/
public void setPlatform(PlatformSpecificationType value) {
this.platform = value;
}
/**
* Gets the value of the address property.
*
* @return
* possible object is
* {@link HexBinaryObjectPropertyType }
*
*/
public HexBinaryObjectPropertyType getAddress() {
return address;
}
/**
* Sets the value of the address property.
*
* @param value
* allowed object is
* {@link HexBinaryObjectPropertyType }
*
*/
public void setAddress(HexBinaryObjectPropertyType value) {
this.address = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof API)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final API that = ((API) object);
{
StructuredTextType lhsDescription;
lhsDescription = this.getDescription();
StructuredTextType rhsDescription;
rhsDescription = that.getDescription();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"description", lhsDescription), LocatorUtils.property(
thatLocator, "description", rhsDescription),
lhsDescription, rhsDescription)) {
return false;
}
}
{
StringObjectPropertyType lhsFunctionName;
lhsFunctionName = this.getFunctionName();
StringObjectPropertyType rhsFunctionName;
rhsFunctionName = that.getFunctionName();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"functionName", lhsFunctionName), LocatorUtils.property(
thatLocator, "functionName", rhsFunctionName),
lhsFunctionName, rhsFunctionName)) {
return false;
}
}
{
StringObjectPropertyType lhsNormalizedFunctionName;
lhsNormalizedFunctionName = this.getNormalizedFunctionName();
StringObjectPropertyType rhsNormalizedFunctionName;
rhsNormalizedFunctionName = that.getNormalizedFunctionName();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"normalizedFunctionName", lhsNormalizedFunctionName),
LocatorUtils
.property(thatLocator, "normalizedFunctionName",
rhsNormalizedFunctionName),
lhsNormalizedFunctionName, rhsNormalizedFunctionName)) {
return false;
}
}
{
PlatformSpecificationType lhsPlatform;
lhsPlatform = this.getPlatform();
PlatformSpecificationType rhsPlatform;
rhsPlatform = that.getPlatform();
if (!strategy
.equals(LocatorUtils.property(thisLocator, "platform",
lhsPlatform), LocatorUtils.property(thatLocator,
"platform", rhsPlatform), lhsPlatform, rhsPlatform)) {
return false;
}
}
{
HexBinaryObjectPropertyType lhsAddress;
lhsAddress = this.getAddress();
HexBinaryObjectPropertyType rhsAddress;
rhsAddress = that.getAddress();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "address", lhsAddress),
LocatorUtils.property(thatLocator, "address", rhsAddress),
lhsAddress, rhsAddress)) {
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);
{
StructuredTextType theDescription;
theDescription = this.getDescription();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"description", theDescription), currentHashCode,
theDescription);
}
{
StringObjectPropertyType theFunctionName;
theFunctionName = this.getFunctionName();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"functionName", theFunctionName), currentHashCode,
theFunctionName);
}
{
StringObjectPropertyType theNormalizedFunctionName;
theNormalizedFunctionName = this.getNormalizedFunctionName();
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"normalizedFunctionName", theNormalizedFunctionName),
currentHashCode, theNormalizedFunctionName);
}
{
PlatformSpecificationType thePlatform;
thePlatform = this.getPlatform();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "platform", thePlatform),
currentHashCode, thePlatform);
}
{
HexBinaryObjectPropertyType theAddress;
theAddress = this.getAddress();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "address", theAddress),
currentHashCode, theAddress);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public API withDescription(StructuredTextType value) {
setDescription(value);
return this;
}
public API withFunctionName(StringObjectPropertyType value) {
setFunctionName(value);
return this;
}
public API withNormalizedFunctionName(StringObjectPropertyType value) {
setNormalizedFunctionName(value);
return this;
}
public API withPlatform(PlatformSpecificationType value) {
setPlatform(value);
return this;
}
public API withAddress(HexBinaryObjectPropertyType value) {
setAddress(value);
return this;
}
@Override
public API withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public API 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);
{
StructuredTextType theDescription;
theDescription = this.getDescription();
strategy.appendField(locator, this, "description", buffer,
theDescription);
}
{
StringObjectPropertyType theFunctionName;
theFunctionName = this.getFunctionName();
strategy.appendField(locator, this, "functionName", buffer,
theFunctionName);
}
{
StringObjectPropertyType theNormalizedFunctionName;
theNormalizedFunctionName = this.getNormalizedFunctionName();
strategy.appendField(locator, this, "normalizedFunctionName",
buffer, theNormalizedFunctionName);
}
{
PlatformSpecificationType thePlatform;
thePlatform = this.getPlatform();
strategy.appendField(locator, this, "platform", buffer, thePlatform);
}
{
HexBinaryObjectPropertyType theAddress;
theAddress = this.getAddress();
strategy.appendField(locator, this, "address", buffer, theAddress);
}
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, API.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 API instance for XML String
*
* @param text
* XML String for the document
* @return The API instance for the passed XML String
*/
public static API fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(API.class.getPackage()
.getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (API) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this API 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());
}
}