org.mitre.cybox.objects.GUIDialogbox 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.IntegerObjectPropertyType;
import org.mitre.cybox.common_2.StringObjectPropertyType;
import org.mitre.stix.DocumentUtilities;
import org.mitre.stix.STIXSchema;
import org.mitre.stix.ValidationEventHandler;
import org.xml.sax.SAXException;
/**
* The GUIDialogboxObjectType type is intended to characterize GUI dialog boxes.
*
* Java class for GUIDialogboxObjectType complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType name="GUIDialogboxObjectType">
* <complexContent>
* <extension base="{http://cybox.mitre.org/objects#GUIObject-2}GUIObjectType">
* <sequence>
* <element name="Box_Caption" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* <element name="Box_Text" type="{http://cybox.mitre.org/common-2}StringObjectPropertyType" minOccurs="0"/>
* </sequence>
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "GUIDialogboxObjectType", namespace = "http://cybox.mitre.org/objects#GUIDialogboxObject-2", propOrder = {
"boxCaption", "boxText" })
@XmlRootElement(name = "GUI_Dialogbox", namespace = "http://cybox.mitre.org/objects#GUIDialogboxObject-2")
public class GUIDialogbox extends GUIObjectType implements Equals, HashCode,
ToString {
@XmlElement(name = "Box_Caption")
protected StringObjectPropertyType boxCaption;
@XmlElement(name = "Box_Text")
protected StringObjectPropertyType boxText;
/**
* Default no-arg constructor
*
*/
public GUIDialogbox() {
super();
}
/**
* Fully-initialising value constructor
*
*/
public GUIDialogbox(final CustomPropertiesType customProperties,
final QName objectReference,
final IntegerObjectPropertyType height,
final IntegerObjectPropertyType width,
final StringObjectPropertyType boxCaption,
final StringObjectPropertyType boxText) {
super(customProperties, objectReference, height, width);
this.boxCaption = boxCaption;
this.boxText = boxText;
}
/**
* Gets the value of the boxCaption property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getBoxCaption() {
return boxCaption;
}
/**
* Sets the value of the boxCaption property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setBoxCaption(StringObjectPropertyType value) {
this.boxCaption = value;
}
/**
* Gets the value of the boxText property.
*
* @return
* possible object is
* {@link StringObjectPropertyType }
*
*/
public StringObjectPropertyType getBoxText() {
return boxText;
}
/**
* Sets the value of the boxText property.
*
* @param value
* allowed object is
* {@link StringObjectPropertyType }
*
*/
public void setBoxText(StringObjectPropertyType value) {
this.boxText = value;
}
public boolean equals(ObjectLocator thisLocator, ObjectLocator thatLocator,
Object object, EqualsStrategy strategy) {
if (!(object instanceof GUIDialogbox)) {
return false;
}
if (this == object) {
return true;
}
if (!super.equals(thisLocator, thatLocator, object, strategy)) {
return false;
}
final GUIDialogbox that = ((GUIDialogbox) object);
{
StringObjectPropertyType lhsBoxCaption;
lhsBoxCaption = this.getBoxCaption();
StringObjectPropertyType rhsBoxCaption;
rhsBoxCaption = that.getBoxCaption();
if (!strategy.equals(LocatorUtils.property(thisLocator,
"boxCaption", lhsBoxCaption), LocatorUtils.property(
thatLocator, "boxCaption", rhsBoxCaption), lhsBoxCaption,
rhsBoxCaption)) {
return false;
}
}
{
StringObjectPropertyType lhsBoxText;
lhsBoxText = this.getBoxText();
StringObjectPropertyType rhsBoxText;
rhsBoxText = that.getBoxText();
if (!strategy.equals(
LocatorUtils.property(thisLocator, "boxText", lhsBoxText),
LocatorUtils.property(thatLocator, "boxText", rhsBoxText),
lhsBoxText, rhsBoxText)) {
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);
{
StringObjectPropertyType theBoxCaption;
theBoxCaption = this.getBoxCaption();
currentHashCode = strategy
.hashCode(LocatorUtils.property(locator, "boxCaption",
theBoxCaption), currentHashCode, theBoxCaption);
}
{
StringObjectPropertyType theBoxText;
theBoxText = this.getBoxText();
currentHashCode = strategy.hashCode(
LocatorUtils.property(locator, "boxText", theBoxText),
currentHashCode, theBoxText);
}
return currentHashCode;
}
public int hashCode() {
final HashCodeStrategy strategy = JAXBHashCodeStrategy.INSTANCE;
return this.hashCode(null, strategy);
}
public GUIDialogbox withBoxCaption(StringObjectPropertyType value) {
setBoxCaption(value);
return this;
}
public GUIDialogbox withBoxText(StringObjectPropertyType value) {
setBoxText(value);
return this;
}
@Override
public GUIDialogbox withHeight(IntegerObjectPropertyType value) {
setHeight(value);
return this;
}
@Override
public GUIDialogbox withWidth(IntegerObjectPropertyType value) {
setWidth(value);
return this;
}
@Override
public GUIDialogbox withCustomProperties(CustomPropertiesType value) {
setCustomProperties(value);
return this;
}
@Override
public GUIDialogbox 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);
{
StringObjectPropertyType theBoxCaption;
theBoxCaption = this.getBoxCaption();
strategy.appendField(locator, this, "boxCaption", buffer,
theBoxCaption);
}
{
StringObjectPropertyType theBoxText;
theBoxText = this.getBoxText();
strategy.appendField(locator, this, "boxText", buffer, theBoxText);
}
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, GUIDialogbox.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 GUIDialogbox instance for XML String
*
* @param text
* XML String for the document
* @return The GUIDialogbox instance for the passed XML String
*/
public static GUIDialogbox fromXMLString(String text) {
JAXBContext jaxbContext;
try {
jaxbContext = JAXBContext.newInstance(GUIDialogbox.class
.getPackage().getName());
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
unmarshaller.setSchema(STIXSchema.getInstance().getSchema());
unmarshaller.setEventHandler(new ValidationEventHandler());
StreamSource streamSource = new StreamSource(new StringReader(text));
return (GUIDialogbox) unmarshaller.unmarshal(streamSource);
} catch (JAXBException e) {
throw new RuntimeException(e);
}
}
/**
* Validates the XML representation of this GUIDialogbox 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());
}
}