org.eclipse.persistence.jaxb.xmlmodel.XmlTransformation Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 1998, 2021 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// mmacivor - August 4th/2010 - 2.2 - Initial implementation
package org.eclipse.persistence.jaxb.xmlmodel;
import java.util.ArrayList;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlType;
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <extension base="{http://www.eclipse.org/eclipselink/xsds/persistence/oxm}java-attribute">
* <sequence>
* <element name="xml-access-methods" type="{http://www.eclipse.org/eclipselink/xsds/persistence/oxm}xml-access-methods" minOccurs="0"/>
* <element ref="{http://www.eclipse.org/eclipselink/xsds/persistence/oxm}xml-properties" minOccurs="0"/>
* <element name="xml-read-transformer">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="method" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="transformer-class" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* <element name="xml-write-transformer" maxOccurs="unbounded" minOccurs="0">
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="method" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="xml-path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="transformer-class" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
* </element>
* </sequence>
* <attribute name="optional" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
* </extension>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"xmlAccessMethods",
"xmlProperties",
"xmlReadTransformer",
"xmlWriteTransformer"
})
public class XmlTransformation
extends JavaAttribute
{
@XmlElement(name = "xml-access-methods")
protected XmlAccessMethods xmlAccessMethods;
@XmlElement(name = "xml-properties")
protected XmlProperties xmlProperties;
@XmlElement(name = "xml-read-transformer", required = true)
protected XmlTransformation.XmlReadTransformer xmlReadTransformer;
@XmlElement(name = "xml-write-transformer")
protected List xmlWriteTransformer;
@XmlAttribute(name = "optional")
protected Boolean optional;
/**
* Gets the value of the xmlAccessMethods property.
*
* @return
* possible object is
* {@link XmlAccessMethods }
*
*/
public XmlAccessMethods getXmlAccessMethods() {
return xmlAccessMethods;
}
/**
* Sets the value of the xmlAccessMethods property.
*
* @param value
* allowed object is
* {@link XmlAccessMethods }
*
*/
public void setXmlAccessMethods(XmlAccessMethods value) {
this.xmlAccessMethods = value;
}
/**
* Gets the value of the xmlProperties property.
*
* @return
* possible object is
* {@link XmlProperties }
*
*/
public XmlProperties getXmlProperties() {
return xmlProperties;
}
/**
* Sets the value of the xmlProperties property.
*
* @param value
* allowed object is
* {@link XmlProperties }
*
*/
public void setXmlProperties(XmlProperties value) {
this.xmlProperties = value;
}
/**
* Indicates if an XmlReadTransformer has been set, i.e. is non-null.
*
*/
public boolean isSetXmlReadTransformer() {
return xmlReadTransformer != null;
}
/**
* Gets the value of the xmlReadTransformer property.
*
* @return
* possible object is
* {@link XmlTransformation.XmlReadTransformer }
*
*/
public XmlTransformation.XmlReadTransformer getXmlReadTransformer() {
return xmlReadTransformer;
}
/**
* Sets the value of the xmlReadTransformer property.
*
* @param value
* allowed object is
* {@link XmlTransformation.XmlReadTransformer }
*
*/
public void setXmlReadTransformer(XmlTransformation.XmlReadTransformer value) {
this.xmlReadTransformer = value;
}
/**
* Indicates if at least one XmlWriteTransformer has been
* set, i.e. the List of is XmlWriteTransformers is non-null
* and non-empty.
*
*/
public boolean isSetXmlWriteTransformers() {
return xmlWriteTransformer != null && xmlWriteTransformer.size() > 0;
}
/**
* Gets the value of the xmlWriteTransformer 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 xmlWriteTransformer property.
*
*
* For example, to add a new item, do as follows:
*
* getXmlWriteTransformer().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link XmlTransformation.XmlWriteTransformer }
*
*
*/
public List getXmlWriteTransformer() {
if (xmlWriteTransformer == null) {
xmlWriteTransformer = new ArrayList();
}
return this.xmlWriteTransformer;
}
/**
* Gets the value of the optional property.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public boolean isOptional() {
if (optional == null) {
return true;
} else {
return optional;
}
}
/**
* Sets the value of the optional property.
*
* @param value
* allowed object is
* {@link Boolean }
*
*/
public void setOptional(Boolean value) {
this.optional = value;
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="method" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="transformer-class" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class XmlReadTransformer {
@XmlAttribute(name = "method")
protected String method;
@XmlAttribute(name = "transformer-class")
protected String transformerClass;
/**
* Gets the value of the method property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getMethod() {
return method;
}
/**
* Sets the value of the method property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setMethod(String value) {
this.method = value;
}
/**
* Indicates if a method has been set, i.e. the method property is non-null.
*
*/
public boolean isSetMethod() {
return method != null;
}
/**
* Gets the value of the transformerClass property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getTransformerClass() {
return transformerClass;
}
/**
* Sets the value of the transformerClass property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setTransformerClass(String value) {
this.transformerClass = value;
}
/**
* Indicates if a transformerClass has been set, i.e. the
* transformerClass property is non-null.
*
*/
public boolean isSetTransformerClass() {
return transformerClass != null;
}
}
/**
* Java class for anonymous complex type.
*
*
The following schema fragment specifies the expected content contained within this class.
*
*
* <complexType>
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <attribute name="method" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="xml-path" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="transformer-class" type="{http://www.w3.org/2001/XMLSchema}string" />
* </restriction>
* </complexContent>
* </complexType>
*
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "")
public static class XmlWriteTransformer {
@XmlAttribute(name = "method")
protected String method;
@XmlAttribute(name = "xml-path", required = true)
protected String xmlPath;
@XmlAttribute(name = "transformer-class")
protected String transformerClass;
/**
* Gets the value of the method property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getMethod() {
return method;
}
/**
* Sets the value of the method property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setMethod(String value) {
this.method = value;
}
/**
* Indicates if a method has been set, i.e. the method property is non-null.
*
*/
public boolean isSetMethod() {
return method != null;
}
/**
* Gets the value of the xmlPath property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getXmlPath() {
return xmlPath;
}
/**
* Sets the value of the xmlPath property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setXmlPath(String value) {
this.xmlPath = value;
}
/**
* Indicates if a xmlPath has been set, i.e. the xmlPath property is non-null.
*
*/
public boolean isSetXmlPath() {
return xmlPath != null;
}
/**
* Gets the value of the transformerClass property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getTransformerClass() {
return transformerClass;
}
/**
* Sets the value of the transformerClass property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setTransformerClass(String value) {
this.transformerClass = value;
}
/**
* Indicates if a transformerClass has been set, i.e. the
* transformerClass property is non-null.
*
*/
public boolean isSetTransformerClass() {
return transformerClass != null;
}
}
}