org.mitre.cybox.objects.ARPCache 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.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The ARPCacheObjectType type is intended to characterize entries in a system's address resolution protocol (ARP) cache.
*
* Java class for ARPCacheObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="ARPCacheObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/common-2}ObjectPropertiesType">
* <sequence>
* <element name="ARP_Cache_Entry" type="{http://cybox.mitre.org/objects#ARPCacheObject-1}ARPCacheEntryType" maxOccurs="unbounded"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ARPCacheObjectType", namespace = "http://cybox.mitre.org/objects#ARPCacheObject-1", propOrder = { "arpCacheEntries" })
@XmlRootElement(name = "ARP_Cache", namespace = "http://cybox.mitre.org/objects#ARPCacheObject-1")
public class ARPCache extends ObjectPropertiesType implements Equals, HashCode,
ToString {
@XmlElement(name = "ARP_Cache_Entry", required = true)
protected List arpCacheEntries;
/**
* Default no-arg constructor
*
*/
public ARPCache() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public ARPCache(final CustomPropertiesType customProperties,
final QName objectReference,
final List arpCacheEntries) {
super(customProperties, objectReference);
this.arpCacheEntries = arpCacheEntries;
}
/**
* Gets the value of the arpCacheEntries 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 arpCacheEntries property.
*
*
* For example, to add a new item, do as follows:
*
* getARPCacheEntries().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ARPCacheEntryType }
*
*
*/
public List getARPCacheEntries() {
if (arpCacheEntries == null) {
arpCacheEntries = new ArrayList();
}
return this.arpCacheEntries;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof ARPCache)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final ARPCache that = ((ARPCache) object);
{
List lhsARPCacheEntries;
lhsARPCacheEntries = (((this.arpCacheEntries != null) && (!this.arpCacheEntries
.isEmpty())) ? this.getARPCacheEntries() : null);
List rhsARPCacheEntries;
rhsARPCacheEntries = (((that.arpCacheEntries != null) && (!that.arpCacheEntries
.isEmpty())) ? that.getARPCacheEntries() : null);
if (!strategy.equals(LocatorUtils.property(thisLocator,
"arpCacheEntries", lhsARPCacheEntries), LocatorUtils
.property(thatLocator, "arpCacheEntries",
rhsARPCacheEntries), lhsARPCacheEntries,
rhsARPCacheEntries)) {
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);
{
List theARPCacheEntries;
theARPCacheEntries = (((this.arpCacheEntries != null) && (!this.arpCacheEntries
.isEmpty())) ? this.getARPCacheEntries() : null);
currentHashCode = strategy.hashCode(LocatorUtils.property(locator,
"arpCacheEntries", theARPCacheEntries), currentHashCode,
theARPCacheEntries);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public ARPCache withARPCacheEntries(ARPCacheEntryType... values) {
if (values != null) {
for (ARPCacheEntryType value : values) {
getARPCacheEntries().add(value);
}
}
return this;
}
public ARPCache withARPCacheEntries(Collection values) {
if (values != null) {
getARPCacheEntries().addAll(values);
}
return this;
}
@Override
public ARPCache withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public ARPCache 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);
{
List theARPCacheEntries;
theARPCacheEntries = (((this.arpCacheEntries != null) && (!this.arpCacheEntries
.isEmpty())) ? this.getARPCacheEntries() : null);
strategy.appendField(locator, this, "arpCacheEntries", buffer,
theARPCacheEntries);
}
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, ARPCache.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 ARPCache instance for XML String
*
* @param text
* XML String for the document
* @return The ARPCache instance for the passed XML String
*/
public static ARPCache fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(ARPCache.class.getPackage()
.getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (ARPCache) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this ARPCache 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());
}
}