Inheritance diagram for org.exolab.castor.builder.CollectionInfoJ2:

Public Member Functions
	CollectionInfoJ2 (XSType contentType, String name, String elementName)
void	generateInitializerCode (JSourceCode jsc)
void	createAccessMethods (JClass jClass)
void	createAddMethod (JMethod method)
void	createAddInsertMethod (JMethod method)
void	createEnumerateMethod (JMethod method)
void	createGetMethod (JMethod method)
void	createGetByIndexMethod (JMethod method)
void	createGetCollectionReferenceMethod (JMethod method)
void	createSetArrayMethod (JMethod method)
void	createSetByIndexMethod (JMethod method)
void	createSetCollectionMethod (JMethod method)
void	createSetCollectionReferenceMethod (JMethod method)
void	createRemoveMethod (JMethod method)
void	createRemoveByObjectMethod (JMethod method)
void	createRemoveByIndexMethod (JMethod method)
void	createRemoveAllMethod (JMethod method)
void	createClearMethod (JMethod method)

Detailed Description

A helper used for generating source that deals with Java 2 Collections.

Author:: Assaf Arkin

Version:

Revision:: 1.2

Date:: 2003/09/12 08:30:13

Constructor & Destructor Documentation

org.exolab.castor.builder.CollectionInfoJ2.CollectionInfoJ2	(	XSType	contentType,
		String	name,
		String	elementName
	)

Parameters:

	contextType	the content type of the collection, ie. the type of objects that the collection will contain
	name	the name of the Collection
	elementName	the element name for each element in collection

References org.exolab.castor.builder.XMLInfo.getSchemaType(), org.exolab.castor.builder.XMLInfo.setSchemaType(), and org.exolab.castor.builder.CollectionInfo.xsList.

Member Function Documentation

void org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods ( JClass jClass )

Creates the Access methods for the collection described by this CollectionInfo

Parameters:

jClass

the JClass to add the methods to.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

void org.exolab.castor.builder.CollectionInfoJ2.createAddInsertMethod ( JMethod method )

Creates implementation of add method with index.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createAddMethod ( JMethod method )

Creates implementation of add method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createClearMethod ( JMethod method )

Creates implementation of clear() method.

Parameters:

method

the JMethod in which to create the source code.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createEnumerateMethod ( JMethod method )

Creates implementation of Enumerate method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.FieldInfo.getName(), and org.exolab.javasource.JMethod.getSourceCode().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createGetByIndexMethod ( JMethod method )

Creates implementation of the get(index) method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.types.XSType.CLASS, org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getReturnType(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.javasource.JSourceCode.indent(), org.exolab.javasource.JType.toString(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createGetCollectionReferenceMethod ( JMethod method )

Creates implementation of collection reference get method. This method simply returns the actual reference to the collection.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JDocComment.addDescriptor(), org.exolab.javasource.JSourceCode.append(), org.exolab.javasource.JDocComment.appendComment(), org.exolab.castor.builder.CollectionInfo.getElementName(), org.exolab.javasource.JMethod.getJDocComment(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.javasource.JDocDescriptor.setDescription().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createGetMethod ( JMethod method )

Creates implementation of object[] get() method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createRemoveAllMethod ( JMethod method )

Creates implementation of removeAll() method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

void org.exolab.castor.builder.CollectionInfoJ2.createRemoveByIndexMethod ( JMethod method )

Creates implementation of remove(int i) method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.types.XSType.CLASS, org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.javasource.JType.getName(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getReturnType(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

void org.exolab.castor.builder.CollectionInfoJ2.createRemoveByObjectMethod ( JMethod method )

Creates implementation of remove(Object) method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

void org.exolab.castor.builder.CollectionInfoJ2.createRemoveMethod ( JMethod method )

Creates implementation of remove(Object) method.

Parameters:

method

the JMethod in which to create the source code.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), and org.exolab.castor.builder.FieldInfo.isBound().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createSetArrayMethod ( JMethod method )

Creates implementation of array set method

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JParameter.getName(), org.exolab.javasource.JMethod.getParameter(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createSetByIndexMethod ( JMethod method )

Creates implementation of set method.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getContentName(), org.exolab.castor.builder.CollectionInfo.getContentType(), org.exolab.castor.builder.types.XSList.getMaximumSize(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.CollectionInfo.getXSList(), org.exolab.javasource.JSourceCode.indent(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JSourceCode.unindent().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionMethod ( JMethod method )

Creates implementation of collection set method. The method will assign the field a copy of the given collection. The fields will be checked for type safety.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createAccessMethods().

void org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionReferenceMethod ( JMethod method )

Creates implementation of collection reference set method. This method is a non-type safe method which simply assigns the given collection to the field.

Parameters:

method

the JMethod in which to create the source code.

Reimplemented from org.exolab.castor.builder.CollectionInfo.

References org.exolab.javasource.JSourceCode.add(), org.exolab.javasource.JSourceCode.append(), org.exolab.javasource.JDocComment.appendComment(), org.exolab.castor.builder.CollectionInfo.createBoundPropertyCode(), org.exolab.castor.builder.CollectionInfo.getElementName(), org.exolab.javasource.JMethod.getJDocComment(), org.exolab.castor.builder.FieldInfo.getName(), org.exolab.javasource.JParameter.getName(), org.exolab.javasource.JDocComment.getParamDescriptor(), org.exolab.javasource.JMethod.getParameter(), org.exolab.javasource.JMethod.getSourceCode(), org.exolab.castor.builder.FieldInfo.isBound(), and org.exolab.javasource.JDocDescriptor.setDescription().