org.netbeans.modules.schema2beans

Class JavaBeansUtil

java.lang.Object

org.netbeans.modules.schema2beans.JavaBeansUtil

public class JavaBeansUtil
extends Object

Author:

Cliff Draper This is a utility class with several static methods for working with generic java beans. There are methods here for writing a java bean out {link writeBeanProperty}, for reading a java bean from XML {link readBean}, and for copying one java bean to another {link copyBean}.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavaBeansUtil.BeanWriter BeanWriter is the generic way of writing a java bean out.
static class	JavaBeansUtil.HtmlBeanWriter
static class	JavaBeansUtil.IndentingBeanWriter The methods in this class will do proper XML indention for you.
static class	JavaBeansUtil.XmlBeanWriter

Method Summary

Modifier and Type	Method and Description
static Object	convertValue(Class type, String value) Convert a textual representation of type stored in value into a java object.
static void	copyBean(Object src, Object dest) Find matching properties between these 2 beans and copy over the contents.
static void	copyBean(Object src, Object dest, Map nameMapping) Find matching properties between these 2 beans and copy over the contents.
static Object	dummyBean(Class cls, int arraySize) Create a bean with dummy values.
static Object	dummyValue(Class type, int arraySize)
static void	genReadType(Writer out, String typeName) Used for generating Java code for reading complicated types.
static void	genWriteType(Writer out, String typeName) Used for generating Java code for writing complicated types.
static boolean	isJavaBeanType(Class type) Determine if type is a java bean or not.
static Object	readBean(Class cls, Document document) Construct a new cls and fill in it's contents from document.
static Object	readBean(Class cls, InputStream in) Construct a new cls and fill in it's contents from in.
static void	readBean(Object obj, Document document) Fill in the contents of obj from the XML that's in document.
static void	readBean(Object obj, InputSource in, boolean validate, EntityResolver er, ErrorHandler eh)
static void	readBean(Object obj, InputStream in) Fill in the contents of obj from the XML that's in in.
static void	readBean(Object obj, Node node)
static void	readBeanNoEntityResolver(Object obj, InputStream in) Warning: in readNoEntityResolver character and entity references will not be read from any DTD in the XML source.
static void	writeBean(Object obj, JavaBeansUtil.BeanWriter out)
static void	writeBean(Object obj, JavaBeansUtil.BeanWriter out, Map skipChildren)
static void	writeBean(Object obj, Writer out) This method is similar to writeBeanProperty except that the outer property name is not known and not printed.
static void	writeBeanProperty(Object obj, JavaBeansUtil.BeanWriter out, Map skipChildren, String propertyName)
static void	writeBeanProperty(Object obj, JavaBeansUtil.BeanWriter out, String propertyName) If you want to write the java bean out in a different way from the standard XML writer, use this method.
static void	writeBeanProperty(Object obj, Writer out, String propertyName) This is the normal top level method for taking a Java Bean and dumping it as XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

writeBeanProperty

public static void writeBeanProperty(Object obj,
                                     Writer out,
                                     String propertyName)
                              throws IOException,
                                     IntrospectionException

This is the normal top level method for taking a Java Bean and dumping it as XML.

Parameters:

obj - the java bean to write out

out - the place to write it to

propertyName - the top level property

Throws:

IOException

IntrospectionException

writeBeanProperty

public static void writeBeanProperty(Object obj,
                                     JavaBeansUtil.BeanWriter out,
                                     String propertyName)
                              throws IOException,
                                     IntrospectionException

If you want to write the java bean out in a different way from the standard XML writer, use this method.

Throws:

IOException

IntrospectionException

writeBeanProperty

public static void writeBeanProperty(Object obj,
                                     JavaBeansUtil.BeanWriter out,
                                     Map skipChildren,
                                     String propertyName)
                              throws IOException,
                                     IntrospectionException

Throws:

IOException

IntrospectionException

writeBean

public static void writeBean(Object obj,
                             Writer out)
                      throws IOException,
                             IntrospectionException

This method is similar to writeBeanProperty except that the outer property name is not known and not printed.

Throws:

IOException

IntrospectionException

writeBean

public static void writeBean(Object obj,
                             JavaBeansUtil.BeanWriter out)
                      throws IOException,
                             IntrospectionException

Throws:

IOException

IntrospectionException

writeBean

public static void writeBean(Object obj,
                             JavaBeansUtil.BeanWriter out,
                             Map skipChildren)
                      throws IOException,
                             IntrospectionException

Throws:

IOException

IntrospectionException

readBean

public static Object readBean(Class cls,
                              InputStream in)
                       throws ParserConfigurationException,
                              SAXException,
                              IOException,
                              IntrospectionException,
                              NoSuchMethodException,
                              InstantiationException,
                              IllegalAccessException,
                              InvocationTargetException

Construct a new cls and fill in it's contents from in.

Parameters:

cls - the Class to construct from the XML.

in - the source of the XML.

Throws:

ParserConfigurationException

SAXException

IOException

IntrospectionException

NoSuchMethodException

InstantiationException

IllegalAccessException

InvocationTargetException

readBean

public static void readBean(Object obj,
                            InputStream in)
                     throws ParserConfigurationException,
                            SAXException,
                            IOException,
                            IntrospectionException

Fill in the contents of obj from the XML that's in in.

Parameters:

obj - the object to fill in from the XML.

in - the source of the XML.

Throws:

ParserConfigurationException

SAXException

IOException

IntrospectionException

readBeanNoEntityResolver

public static void readBeanNoEntityResolver(Object obj,
                                            InputStream in)
                                     throws ParserConfigurationException,
                                            SAXException,
                                            IOException,
                                            IntrospectionException

Warning: in readNoEntityResolver character and entity references will not be read from any DTD in the XML source. However, this way is faster since no DTDs are looked up (possibly skipping network access) or parsed.

Throws:

ParserConfigurationException

SAXException

IOException

IntrospectionException

readBean

public static void readBean(Object obj,
                            InputSource in,
                            boolean validate,
                            EntityResolver er,
                            ErrorHandler eh)
                     throws ParserConfigurationException,
                            SAXException,
                            IOException,
                            IntrospectionException

Throws:

ParserConfigurationException

SAXException

IOException

IntrospectionException

readBean

public static Object readBean(Class cls,
                              Document document)
                       throws IntrospectionException,
                              NoSuchMethodException,
                              InstantiationException,
                              IllegalAccessException,
                              InvocationTargetException

Construct a new cls and fill in it's contents from document.

Parameters:

cls - the Class to construct from the XML.

document - the source of the XML.

Throws:

IntrospectionException

NoSuchMethodException

InstantiationException

IllegalAccessException

InvocationTargetException

readBean

public static void readBean(Object obj,
                            Document document)
                     throws IntrospectionException

Fill in the contents of obj from the XML that's in document.

Parameters:

obj - the object to fill in from the XML.

document - the source of the XML.

Throws:

IntrospectionException

readBean

public static void readBean(Object obj,
                            Node node)
                     throws IntrospectionException

Throws:

IntrospectionException

copyBean

public static void copyBean(Object src,
                            Object dest)
                     throws IntrospectionException

Find matching properties between these 2 beans and copy over the contents.

Throws:

IntrospectionException

copyBean

public static void copyBean(Object src,
                            Object dest,
                            Map nameMapping)
                     throws IntrospectionException

Find matching properties between these 2 beans and copy over the contents.

Parameters:

nameMapping - maps property names from the src object to the dest object.

Throws:

IntrospectionException

isJavaBeanType

public static boolean isJavaBeanType(Class type)

Determine if type is a java bean or not. This is a tough decision. This method is called to figure out at what types to stop recursing in the bean graph. Any type that is not simple enough is called a java bean.

convertValue

public static Object convertValue(Class type,
                                  String value)

Convert a textual representation of type stored in value into a java object. If we don't know the type, then look for a constructor that takes a single String as a parameter.

genReadType

public static void genReadType(Writer out,
                               String typeName)
                        throws IOException

Used for generating Java code for reading complicated types.

Parameters:

typeName - the java type to generate the method about, can also be "base64Binary".

Throws:

IOException

genWriteType

public static void genWriteType(Writer out,
                                String typeName)
                         throws IOException

Used for generating Java code for writing complicated types.

Parameters:

typeName - the java type to generate the method about, can also be "base64Binary".

Throws:

IOException

dummyBean

public static Object dummyBean(Class cls,
                               int arraySize)
                        throws IntrospectionException

Create a bean with dummy values. If a bean property write method fails or the constructor to the bean fails, then a null value is used.

Throws:

IntrospectionException

dummyValue

public static Object dummyValue(Class type,
                                int arraySize)

Returns:

dummy value for a particular type. If it's not a standard type, then look for a constructor that takes a single String as a parameter; if that fails, then return null.