org.exolab.castor.xml.descriptors.LocaleDescriptor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of castor-xml Show documentation
Show all versions of castor-xml Show documentation
The core XML data binding framework with support for marshalling Java objects to
and unmarshalling from XML documents.
The newest version!
/*
* Redistribution and use of this software and associated documentation ("Software"), with or
* without modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain copyright statements and notices. Redistributions
* must also contain a copy of this document.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other materials provided with
* the distribution.
*
* 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
* without prior written permission of Intalio, Inc. For written permission, please contact
* [email protected].
*
* 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
* their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
* Intalio, Inc.
*
* 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
*
* THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Copyright 2000-2004 (C) Intalio, Inc. All Rights Reserved.
*
* $Id$
*/
package org.exolab.castor.xml.descriptors;
import java.util.Locale;
import org.exolab.castor.mapping.AccessMode;
import org.exolab.castor.mapping.ClassDescriptor;
import org.exolab.castor.mapping.FieldDescriptor;
import org.exolab.castor.xml.NodeType;
import org.exolab.castor.xml.TypeValidator;
import org.exolab.castor.xml.UnmarshalState;
import org.exolab.castor.xml.ValidationException;
import org.exolab.castor.xml.XMLClassDescriptor;
import org.exolab.castor.xml.XMLFieldDescriptor;
import org.exolab.castor.xml.XMLFieldHandler;
import org.exolab.castor.xml.util.XMLFieldDescriptorImpl;
/**
* A ClassDescriptor for java.util.Locale.
*
* @author Keith Visco
* @version $Revision$ $Date: 2004-12-16 22:45:54 -0700 (Thu, 16 Dec 2004) $
*/
public class LocaleDescriptor extends BaseDescriptor {
/** Used for returning no attribute and no element fields. */
private static final XMLFieldDescriptor[] NO_FIELDS = new XMLFieldDescriptor[0];
/** Our field descriptor for our "content". */
private static final XMLFieldDescriptorImpl NO_CONTENT = null;
/** The name of the XML element. */
private static final String XML_NAME = "locale";
/** Our field descriptor array. Lists the fields we describe. */
private static final XMLFieldDescriptor[] FIELDS;
/** The TypeValidator to use for validation of the described class. */
private static final TypeValidator VALIDATOR = null;
static {
// -- Create FieldDescriptor for language
XMLFieldDescriptorImpl fdLanguage =
new XMLFieldDescriptorImpl(String.class, "language", "language", NodeType.Attribute);
fdLanguage.setConstructorArgumentIndex(0);
fdLanguage.setHandler(new XMLFieldHandler() {
/**
* {@inheritDoc}
*/
public Object getValue(final Object object) throws IllegalStateException {
return ((java.util.Locale) object).getLanguage();
}
/**
* {@inheritDoc}
*/
public void setValue(final Object object, final Object value)
throws IllegalStateException, IllegalArgumentException {
// -- do nothing, can only be set via constructor
}
/**
* {@inheritDoc}
*/
public Object newInstance(final Object parent) {
// -- not applicable
return null;
}
});
// -- Create FieldDescriptor for country
XMLFieldDescriptorImpl fdCountry =
new XMLFieldDescriptorImpl(String.class, "country", "country", NodeType.Attribute);
fdCountry.setConstructorArgumentIndex(1);
fdCountry.setHandler(new XMLFieldHandler() {
/**
* {@inheritDoc}
*/
public Object getValue(final Object object) throws IllegalStateException {
return ((java.util.Locale) object).getCountry();
}
/**
* {@inheritDoc}
*/
public void setValue(final Object object, final Object value)
throws IllegalStateException, IllegalArgumentException {
// -- do nothing, can only be set via constructor
}
/**
* {@inheritDoc}
*/
public Object newInstance(final Object parent) {
// -- not applicable
return null;
}
});
// // -- Create FieldDescriptor for language variant
// XMLFieldDescriptorImpl fdVariant = new XMLFieldDescriptorImpl(
// String.class, "variant", "variant", NodeType.Attribute);
//
// fdVariant.setConstructorArgumentIndex(2);
// fdVariant.setRequired(false);
// fdVariant.setHandler(new XMLFieldHandler() {
//
// /**
// * {@inheritDoc}
// */
// public Object getValue(final Object object) throws IllegalStateException {
// String variant = ((Locale) object).getVariant();
// if (variant == null || variant.length() == 0) {
// return null;
// }
//
// return variant;
// }
//
// /**
// * {@inheritDoc}
// */
// public void setValue(final Object object, final Object value)
// throws IllegalStateException, IllegalArgumentException {
// // -- do nothing, can only be set via constructor
// }
//
// /**
// * {@inheritDoc}
// */
// public Object newInstance(final Object parent) {
// // -- not applicable
// return null;
// }
// });
FIELDS = new XMLFieldDescriptor[2];
FIELDS[0] = fdCountry;
FIELDS[1] = fdLanguage;
// _fields[2] = fdVariant;
}
// ----------------/
// - Constructors -/
// ----------------/
/**
* No-arg constructor.
*/
public LocaleDescriptor() {
super();
} // -- LocaleDescriptor
// ------------------/
// - Public Methods -/
// ------------------/
/**
* Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML
* attributes.
*
* @return an array of XMLFieldDescriptors for all members that should be marshaled as XML
* attributes.
*/
public XMLFieldDescriptor[] getAttributeDescriptors() {
return FIELDS;
} // getAttributeDescriptors
/**
* Returns the XMLFieldDescriptor for the member that should be marshaled as text content.
*
* @return the XMLFieldDescriptor for the member that should be marshaled as text content.
*/
public XMLFieldDescriptor getContentDescriptor() {
return NO_CONTENT;
} // getContentDescriptor
/**
* Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML
* elements.
*
* @return an array of XMLFieldDescriptors for all members that should be marshaled as XML
* elements.
*/
public XMLFieldDescriptor[] getElementDescriptors() {
return NO_FIELDS;
} // getElementDescriptors
/**
* Returns the XML field descriptor matching the given xml name and nodeType. If NodeType is null,
* then either an AttributeDescriptor, or ElementDescriptor may be returned. Null is returned if
* no matching descriptor is available.
*
* @param name the xml name to match against
* @param namespace the namespace uri
* @param nodeType the NodeType to match against, or null if the node type is not known.
* @return the matching descriptor, or null if no matching descriptor is available.
*/
public XMLFieldDescriptor getFieldDescriptor(final String name, final String namespace,
final NodeType nodeType) {
return null;
} // -- getFieldDescriptor
/**
* @return the namespace prefix to use when marshaling as XML.
*/
public String getNameSpacePrefix() {
return null;
} // -- getNameSpacePrefix
/**
* @return the namespace URI used when marshaling and unmarshaling as XML.
*/
public String getNameSpaceURI() {
return null;
} // -- getNameSpaceURI
/**
* Returns a specific validator for the class described by this ClassDescriptor. A null value may
* be returned if no specific validator exists.
*
* @return the type validator for the class described by this ClassDescriptor.
*/
public TypeValidator getValidator() {
return VALIDATOR;
} // -- getValidator
/**
* Returns the XML Name for the Class being described.
*
* @return the XML name.
*/
public String getXMLName() {
return XML_NAME;
} // -- getXMLName
/**
* Returns the String representation of this XMLClassDescriptor.
*
* @return the String representation of this XMLClassDescriptor.
*/
public String toString() {
return super.toString() + "; descriptor for class: " + Locale.class.getName() + "; xml name: "
+ XML_NAME;
} // -- toString
// -------------------------------------/
// - Implementation of ClassDescriptor -/
// -------------------------------------/
/**
* Returns the Java class represented by this descriptor.
*
* @return The Java class
*/
public Class getJavaClass() {
return Locale.class;
} // -- getJavaClass
/**
* Returns a list of fields represented by this descriptor.
*
* @return A list of fields
*/
public FieldDescriptor[] getFields() {
return FIELDS;
} // -- getFields
/**
* Returns the class descriptor of the class extended by this class.
*
* @return The extended class descriptor
*/
public ClassDescriptor getExtends() {
return null;
} // -- getExtends
/**
* Returns the identity field, null if this class has no identity.
*
* @return The identity field
*/
public FieldDescriptor getIdentity() {
return null;
} // -- getIdentity
/**
* Returns the access mode specified for this class.
*
* @return The access mode
*/
public AccessMode getAccessMode() {
return null;
} // -- getAccessMode
} // -- class: LocaleDescriptor