Author: rdonkin
Date: Sun Jun 5 08:50:03 2005
New Revision: 180104
URL: http://svn.apache.org/viewcvs?rev=180104&view=rev
Log:
Changes to correct javadoc errors.
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BeanProperty.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BindingConfiguration.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/ElementDescriptor.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/IntrospectionConfiguration.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/Options.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/XMLIntrospector.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/digester/MappedPropertyRule.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/expression/DynaBeanUpdater.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/AbstractBeanWriter.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanCreateRule.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanReader.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanRuleSet.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanWriter.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/WriteContext.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/id/RandomIDGenerator.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/read/ReadContext.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/registry/PolymorphicReferenceResolver.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/Attribute.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/ComplexType.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalComplexType.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalElement.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/SimpleType.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/HyphenatedNameMapper.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/IdStoringStrategy.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/ListedClassNormalizer.java
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/MixedContentEncodingStrategy.java
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BeanProperty.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BeanProperty.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BeanProperty.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BeanProperty.java
Sun Jun 5 08:50:03 2005
@@ -141,7 +141,7 @@
* Go through and work out whether it's a loop property, a primitive or a
standard.
* The class property is ignored.
*
- * @param beanProperty the BeanProperty specifying the property
+ * @param configuration <code>IntrospectionConfiguration</code>, not null
* @return a correctly configured <code>NodeDescriptor</code> for the
property
*/
public Descriptor createXMLDescriptor( IntrospectionConfiguration
configuration ) {
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BindingConfiguration.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BindingConfiguration.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BindingConfiguration.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/BindingConfiguration.java
Sun Jun 5 08:50:03 2005
@@ -155,7 +155,7 @@
/**
* Gets the strategy used to manage storage and retrieval of id's.
*
- * @return Returns the idStoringStrategy, not null
+ * @return Returns the <code>IdStoringStrategy</code>, not null
*/
public IdStoringStrategy getIdMappingStrategy() {
return idStoringStrategy;
@@ -164,8 +164,8 @@
/**
* Sets the strategy used to manage storage and retrieval of id's.
*
- * @param idStoringStrategy
- * The idStoringStrategy to set, not null
+ * @param idMappingStrategy
+ * <code>IdStoringStrategy</code> to be set, not null
*/
public void setIdMappingStrategy(IdStoringStrategy idMappingStrategy) {
this.idStoringStrategy = idMappingStrategy;
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/ElementDescriptor.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/ElementDescriptor.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/ElementDescriptor.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/ElementDescriptor.java
Sun Jun 5 08:50:03 2005
@@ -173,11 +173,13 @@
}
/**
- * Is this a simple element?
+ * <p>Is this a simple element?</p>
+ * <p>
* A simple element is one without child elements or attributes.
* This corresponds to the simple type concept used in XML Schema.
* TODO: need to consider whether it's sufficient to calculate
- * which are simple types (and so don't get IDs assigned etc)
+ * which are simple types (and so don't get IDs assigned etc).
+ * </p>
* @return true if it is a <code>SimpleType</code> element
*/
public boolean isSimple() {
@@ -306,7 +308,7 @@
* passed in, unless some other matches the name exactly.
*
* @param name the localname to be matched, not null
- * @returns the child ElementDescriptor with the given name if one
exists,
+ * @return the child ElementDescriptor with the given name if one exists,
* otherwise null
*/
public ElementDescriptor getElementDescriptor(String name) {
@@ -560,10 +562,11 @@
}
/**
- * TODO is this implementation correct?
- * maybe this method is unnecessary
+ * Does this describe a collective?
*/
public boolean isCollective() {
+ // TODO is this implementation correct?
+ // maybe this method is unnecessary
return isCollectiveType;
}
@@ -576,9 +579,12 @@
}
/**
- * @todo is this really a good design?
+ * Finds the parent of the given descriptor.
+ * @param elementDescriptor <code>ElementDescriptor</code>
+ * @return <code>ElementDescriptor</code>, not null
*/
public ElementDescriptor findParent(ElementDescriptor elementDescriptor) {
+ //TODO: is this really a good design?
ElementDescriptor result = null;
ElementDescriptor[] elementDescriptors = getElementDescriptors();
for (int i=0, size=elementDescriptors.length; i<size; i++) {
@@ -610,13 +616,15 @@
}
/**
- * Is this decriptor hollow?
+ * <p>Is this decriptor hollow?</p>
+ * <p>
* A hollow descriptor is one which gives only the class that the subgraph
* is mapped to rather than describing the entire subgraph.
* A new <code>XMLBeanInfo</code> should be introspected
* and that used to describe the subgraph.
* A hollow descriptor should not have any child descriptors.
* TODO: consider whether a subclass would be better
+ * </p>
* @return true if this is hollow
*/
public boolean isHollow() {
@@ -631,18 +639,19 @@
* and that used to describe the subgraph.
* A hollow descriptor should not have any child descriptors.
* TODO: consider whether a subclass would be better
- * @param true if this is hollow
+ * @param isHollow true if this is hollow
*/
public void setHollow(boolean isHollow) {
this.isHollow = isHollow;
}
/**
- * Is the bind time type to be used to determine the mapping?
+ * <p>Is the bind time type to be used to determine the mapping?</p>
+ * <p>
* The mapping for an object property value can either be the
* introspection time type (based on the logical type of the property)
* or the bind time type (based on the type of the actual instance).
- *
+ * </p>
* @return true if the bind time type is to be used to determine the
mapping,
* false if the introspection time type is to be used
*/
@@ -655,7 +664,7 @@
}
/**
- * <p>Sets whether the bind time type to be used to determine the mapping?
+ * <p>Sets whether the bind time type to be used to determine the mapping.
* The mapping for an object property value can either be the
* introspection time type (based on the logical type of the property)
* or the bind time type (based on the type of the actual instance).
@@ -674,9 +683,11 @@
}
/**
- * Is this a polymorphic element?
+ * <p>Is this a polymorphic element?</p>
+ * <p>
* A polymorphic element's name is not fixed at
* introspection time and it's resolution is postponed to bind time.
+ * </p>
* @return true if [EMAIL PROTECTED] #getQualifiedName} is null,
* false otherwise
*/
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/IntrospectionConfiguration.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/IntrospectionConfiguration.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/IntrospectionConfiguration.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/IntrospectionConfiguration.java
Sun Jun 5 08:50:03 2005
@@ -227,8 +227,10 @@
}
/**
- * Should the original <code>java.reflect.Introspector</code> bean info
search path be used?
- * By default it will be false.
+ * <p>Should the original <code>java.reflect.Introspector</code> bean info
search path be used?</p>
+ * <p>
+ * Default is false.
+ * </p>
*
* @return boolean if the beanInfoSearchPath should be used.
*/
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/Options.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/Options.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/Options.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/Options.java
Sun Jun 5 08:50:03 2005
@@ -43,7 +43,7 @@
/**
* Gets the names of each option.
- * @return
+ * @return <code>String</code> array containing the name of each option
*/
public String[] getNames() {
Set names = valuesByName.keySet();
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/XMLIntrospector.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/XMLIntrospector.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/XMLIntrospector.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/XMLIntrospector.java
Sun Jun 5 08:50:03 2005
@@ -828,17 +828,16 @@
* called multiple times. This is relatively expensive and so it'd be
better
* to push into a proper class and cache.
* <br>
- * TODO this probably does work properly with DynaBeans: need to push
- * implementation into an class and expose it on BeanType.
- *
- * @param introspector use this <code>XMLIntrospector</code> for
introspection
+ *
* @param rootDescriptor add defaults to this descriptor
* @param beanClass the <code>Class</code> to which descriptor corresponds
*/
public void defaultAddMethods(
ElementDescriptor rootDescriptor,
Class beanClass ) {
-
+ // TODO: this probably does work properly with DynaBeans: need to push
+ // implementation into an class and expose it on BeanType.
+
// lets iterate over all methods looking for one of the form
// add*(PropertyType)
if ( beanClass != null ) {
@@ -1392,12 +1391,13 @@
/**
* Is this class a primitive?
- * TODO: this method will probably be deprecated when primitive types
- * are subsumed into the simple type concept
+ *
* @param type the Class to test
* @return true for primitive types
*/
public boolean isPrimitiveType(Class type) {
+ // TODO: this method will probably be deprecated when primitive types
+ // are subsumed into the simple type concept
TypeBindingStrategy.BindingType bindingType
= configuration.getTypeBindingStrategy().bindingType(
type ) ;
boolean result =
(bindingType.equals(TypeBindingStrategy.BindingType.PRIMITIVE));
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/digester/MappedPropertyRule.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/digester/MappedPropertyRule.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/digester/MappedPropertyRule.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/digester/MappedPropertyRule.java
Sun Jun 5 08:50:03 2005
@@ -26,7 +26,7 @@
* Maybe a lot of this should be moved into <code>BeanUtils</code>.</p>
*
* @author Robert Burrell Donkin
- * @sinec 0.5
+ * @since 0.5
*/
public abstract class MappedPropertyRule extends RuleSupport {
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/expression/DynaBeanUpdater.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/expression/DynaBeanUpdater.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/expression/DynaBeanUpdater.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/expression/DynaBeanUpdater.java
Sun Jun 5 08:50:03 2005
@@ -50,7 +50,7 @@
/**
* Executes the update on the given code>DynaBean</code>
- * @see
org.apache.commons.betwixt.expression.TypedUpdater#executeUpdate(java.lang.Object,
java.lang.Object)
+ * @see
org.apache.commons.betwixt.expression.TypedUpdater#executeUpdate(Context,
java.lang.Object, java.lang.Object)
*/
protected void executeUpdate(Context context, Object bean, Object value)
throws Exception {
if (bean instanceof DynaBean)
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/AbstractBeanWriter.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/AbstractBeanWriter.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/AbstractBeanWriter.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/AbstractBeanWriter.java
Sun Jun 5 08:50:03 2005
@@ -38,14 +38,6 @@
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
-// FIX ME!!!
-// Logging logic!
-
-// FIX ME!!
-// Error handling strategy!
-// i'm going to add SAXExceptions everywhere since it's the easiest way to
make things work quick
-// but this is a poor strategy
-
/**
* <p>Abstract superclass for bean writers.
* This class encapsulates the processing logic.
@@ -193,7 +185,7 @@
* </p>
* @see #write(Object) since the standard notes also apply
* @param bean <code>Object</code> to be written as xml, not null
- * @param mapping <code>InputSource/code> containing an xml document
+ * @param source <code>InputSource/code> containing an xml document
* specifying the mapping to be used (in the usual way), not null
* @throws IOException
* @throws SAXException
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanCreateRule.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanCreateRule.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanCreateRule.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanCreateRule.java
Sun Jun 5 08:50:03 2005
@@ -540,8 +540,9 @@
return (BeanReader) getDigester();
}
- /** Allows the navigation from a reference to a property object to the
descriptor defining what
- * the property is. i.e. doing the join from a reference to a type to
lookup its descriptor.
+ /**
+ * Allows the navigation from a reference to a property object to the
descriptor defining what
+ * the property is. In other words, doing the join from a reference to a
type to lookup its descriptor.
* This could be done automatically by the NodeDescriptors. Refer to
TODO.txt for more info.
*
* @param propertyDescriptor find descriptor for property object
referenced by this descriptor
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanReader.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanReader.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanReader.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanReader.java
Sun Jun 5 08:50:03 2005
@@ -201,9 +201,9 @@
* It is recommended that use of the pre-registeration process provided
* by [EMAIL PROTECTED] XMLIntrospector#register} be considered as an
alternative to this method.
* </p>
- * @see [EMAIL PROTECTED] #registerBeanClass(Class)} since the general
notes given there
+ * @see #registerBeanClass(Class) since the general notes given there
* apply equally to this
- * @see [EMAIL PROTECTED] XMLIntrospector#register(InputSource) for more
details on the multi-mapping format
+ * @see XMLIntrospector#register(InputSource) for more details on the
multi-mapping format
* @param mapping <code>InputSource</code> giving the multi-mapping
document specifying
* the mapping
* @throws IntrospectionException
@@ -232,7 +232,7 @@
* It is recommended that use of the pre-registeration process provided
* by [EMAIL PROTECTED] XMLIntrospector#register} be considered as an
alternative to this method.
* </p>
- * @see [EMAIL PROTECTED] #registerBeanClass(Class)} since the general
notes given there
+ * @see #registerBeanClass(Class) since the general notes given there
* apply equally to this
* @param mapping <code>InputSource</code> giving the dot betwixt document
specifying
* the mapping
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanRuleSet.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanRuleSet.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanRuleSet.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanRuleSet.java
Sun Jun 5 08:50:03 2005
@@ -95,7 +95,6 @@
* @param introspector the <code>XMLIntrospector</code> used to introspect
* @param basePath specifies the (Digester-style) path under which the
rules will be attached
* @param baseElementDescriptor the <code>ElementDescriptor</code> used to
create the rules
- * @param baseBeanClass the <code>Class</code> whose mapping rules will be
created
* @param context the root Context that bean carrying Contexts should be
obtained from,
* not null
* @deprecated 0.6 use the constructor which takes a ReadContext instead
@@ -192,7 +191,7 @@
//-------------------------------- Ruleset implementation
/**
- * <p>Return namespace associated with this ruleset</p>
+ * <p>Gets the namespace associated with this ruleset.</p>
*
* <p><strong>Note</strong> namespaces are not currently supported.</p>
*
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanWriter.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanWriter.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanWriter.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/BeanWriter.java
Sun Jun 5 08:50:03 2005
@@ -290,12 +290,14 @@
}
/**
- * Should an end tag be added for each empty element?
+ * <p>Should an end tag be added for each empty element?
+ * </p><p>
* When this property is false then empty elements will
* be written as <code><<em>element-name</em>/gt;</code>.
* When this property is true then empty elements will
* be written as <code><<em>element-name</em>gt;
* </<em>element-name</em>gt;</code>.
+ * </p>
* @return true if an end tag should be added
*/
public boolean isEndTagForEmptyElement() {
@@ -303,7 +305,7 @@
}
/**
- * Sets when an an end tag be added for each empty element?
+ * Sets when an an end tag be added for each empty element.
* When this property is false then empty elements will
* be written as <code><<em>element-name</em>/gt;</code>.
* When this property is true then empty elements will
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/WriteContext.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/WriteContext.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/WriteContext.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/WriteContext.java
Sun Jun 5 08:50:03 2005
@@ -30,7 +30,7 @@
* It is likely that access will be required to methods in the
* <code>Context</code> used by the [EMAIL PROTECTED] AbstractBeanWriter}
* but it seems better to add these as neccessary using delegation
- * rather than extending [EMAIL PROTECTED] Context}.
+ * rather than extending [EMAIL PROTECTED]
org.apache.commons.betwixt.expression.Context}.
* </p>
* @author <a href='http://jakarta.apache.org/'>Jakarta Commons Team</a>
* @since 0.5
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/id/RandomIDGenerator.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/id/RandomIDGenerator.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/id/RandomIDGenerator.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/id/RandomIDGenerator.java
Sun Jun 5 08:50:03 2005
@@ -57,7 +57,7 @@
}
/**
- * <p>Generates a random <code>ID</code><p>
+ * <p>Generates a random <code>ID</code>.</p>
*
* <p>If the <code>PositiveIds</code> property is true,
* then this method will recursively call itself if the random
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/read/ReadContext.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/read/ReadContext.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/read/ReadContext.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/io/read/ReadContext.java
Sun Jun 5 08:50:03 2005
@@ -319,7 +319,7 @@
/**
* Pops an action mapping from the stack
- * @return
+ * @return <code>MappingAction</code>, not null
*/
public MappingAction popMappingAction() {
return (MappingAction) actionMappingStack.pop();
@@ -358,7 +358,7 @@
/**
* Pops the last mapping <code>Object</code> from the
* stack containing beans that have been mapped.
- * @return
+ * @return the last bean pushed onto the stack
*/
public Object popBean() {
return objectStack.pop();
@@ -375,7 +375,7 @@
/**
* Gets the <code>XMLIntrospector</code> to be used to create
* the mappings for the xml.
- * @return <code>XMLIntrospector, not null
+ * @return <code>XMLIntrospector</code>, not null
*/
public XMLIntrospector getXMLIntrospector() {
// read context is not intended to be used by multiple threads
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/registry/PolymorphicReferenceResolver.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/registry/PolymorphicReferenceResolver.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/registry/PolymorphicReferenceResolver.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/registry/PolymorphicReferenceResolver.java
Sun Jun 5 08:50:03 2005
@@ -32,7 +32,7 @@
/**
* Resolves the bind-time type of a polymorphic element.
- * @param descriptor <code>ElementMapping</code> describing the
(polymorphic) element being mapped,
+ * @param mapping <code>ElementMapping</code> describing the (polymorphic)
element being mapped,
* not null
* @param context <code>ReadContext</code>, not null
* @return the <code>Class</code> describing the type to which this
element should be bound,
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/Attribute.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/Attribute.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/Attribute.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/Attribute.java
Sun Jun 5 08:50:03 2005
@@ -44,7 +44,7 @@
/**
* Gets the attribute name
- * @return
+ * @return name of this attribute, not null
*/
public String getName() {
return name;
@@ -52,7 +52,7 @@
/**
* Sets the attribute name
- * @param string
+ * @param string the name for this attribute, not null
*/
public void setName(String string) {
name = string;
@@ -60,7 +60,7 @@
/**
* Gets the attribute type
- * @return
+ * @return the type of this attribute
*/
public String getType() {
return type;
@@ -68,7 +68,7 @@
/**
* Sets the attribute type
- * @param string
+ * @param string the attribute type
*/
public void setType(String string) {
type = string;
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/ComplexType.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/ComplexType.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/ComplexType.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/ComplexType.java
Sun Jun 5 08:50:03 2005
@@ -12,7 +12,7 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
- */
+ */
package org.apache.commons.betwixt.schema;
@@ -25,10 +25,11 @@
import org.apache.commons.betwixt.XMLBeanInfo;
/**
- * Models a <code>complexType</code>.
- * Global (top level) complex types are represented by [EMAIL PROTECTED]
GlobalComplexType}.
- * Locally defined or referenced complex types are represented by [EMAIL
PROTECTED] LocalComplexType}.
- * @author <a href='http://jakarta.apache.org/'>Jakarta Commons Team</a>
+ * Models a <code>complexType</code>. Global (top level) complex types are
+ * represented by [EMAIL PROTECTED] GlobalComplexType}. Locally defined or
referenced
+ * complex types are represented by [EMAIL PROTECTED] LocalComplexType}.
+ *
+ * @author <a href='http://jakarta.apache.org/'>Jakarta Commons Team </a>
* @version $Revision$
*/
public abstract class ComplexType {
@@ -37,20 +38,25 @@
protected List attributes = new ArrayList();
- public ComplexType() {}
+ public ComplexType() {
+ }
- public ComplexType(TranscriptionConfiguration configuration,
ElementDescriptor elementDescriptor, Schema schema) throws
IntrospectionException {
+ public ComplexType(TranscriptionConfiguration configuration,
+ ElementDescriptor elementDescriptor, Schema schema)
+ throws IntrospectionException {
elementDescriptor = fillDescriptor(elementDescriptor, schema);
- init(configuration, elementDescriptor, schema);
+ init(configuration, elementDescriptor, schema);
}
/**
* @param elementDescriptor
* @param schema
- * @return
- * @throws IntrospectionException
+ * @return @throws
+ * IntrospectionException
*/
- protected ElementDescriptor fillDescriptor(ElementDescriptor
elementDescriptor, Schema schema) throws IntrospectionException {
+ protected ElementDescriptor fillDescriptor(
+ ElementDescriptor elementDescriptor, Schema schema)
+ throws IntrospectionException {
if (elementDescriptor.isHollow()) {
// need to introspector for filled descriptor
Class type = elementDescriptor.getSingularPropertyType();
@@ -63,70 +69,81 @@
return elementDescriptor;
}
- protected void init(TranscriptionConfiguration configuration,
ElementDescriptor elementDescriptor, Schema schema) throws
IntrospectionException {
-
- AttributeDescriptor[] attributeDescriptors =
elementDescriptor.getAttributeDescriptors();
- for (int i=0,length=attributeDescriptors.length; i<length ; i++) {
+ protected void init(TranscriptionConfiguration configuration,
+ ElementDescriptor elementDescriptor, Schema schema)
+ throws IntrospectionException {
+
+ AttributeDescriptor[] attributeDescriptors = elementDescriptor
+ .getAttributeDescriptors();
+ for (int i = 0, length = attributeDescriptors.length; i < length; i++)
{
//TODO: need to think about computing schema types from descriptors
// this will probably depend on the class mapped to
String uri = attributeDescriptors[i].getURI();
- if (! SchemaTranscriber.W3C_SCHEMA_INSTANCE_URI.equals(uri)) {
+ if (!SchemaTranscriber.W3C_SCHEMA_INSTANCE_URI.equals(uri)) {
attributes.add(new Attribute(attributeDescriptors[i]));
}
}
-
+
//TODO: add support for spacing elements
- ElementDescriptor[] elementDescriptors =
elementDescriptor.getElementDescriptors();
- for (int i=0,length=elementDescriptors.length; i<length ; i++) {
+ ElementDescriptor[] elementDescriptors = elementDescriptor
+ .getElementDescriptors();
+ for (int i = 0, length = elementDescriptors.length; i < length; i++) {
if (elementDescriptors[i].isHollow()) {
- elements.add(new ElementReference(configuration,
elementDescriptors[i], schema));
- } else if (elementDescriptors[i].isSimple()){
- elements.add(new SimpleLocalElement(configuration,
elementDescriptors[i], schema));
+ elements.add(new ElementReference(configuration,
+ elementDescriptors[i], schema));
+ } else if (elementDescriptors[i].isSimple()) {
+ elements.add(new SimpleLocalElement(configuration,
+ elementDescriptors[i], schema));
} else {
- elements.add(new ComplexLocalElement(configuration,
elementDescriptors[i], schema));
+ elements.add(new ComplexLocalElement(configuration,
+ elementDescriptors[i], schema));
}
- }
+ }
}
/**
- * Gets the elements contained by this type
- * @return
- */
+ * Gets the elements contained by this type
+ *
+ * @return <code>List</code> of contained elements, not null
+ */
public List getElements() {
- return elements;
+ return elements;
}
/**
- * Adds an element to those contained by this type
- * @param element
- */
+ * Adds an element to those contained by this type
+ *
+ * @param element
+ */
public void addElement(ElementReference element) {
elements.add(element);
}
-
- /**
- * Adds an element to those contained by this type
- * @param element
- */
- public void addElement(LocalElement element) {
- elements.add(element);
- }
+ /**
+ * Adds an element to those contained by this type
+ *
+ * @param element
+ */
+ public void addElement(LocalElement element) {
+ elements.add(element);
+ }
/**
- * Gets the attributes contained by this type.
- * @return
- */
+ * Gets the attributes contained by this type.
+ *
+ * @return <code>List</code> of attributes
+ */
public List getAttributes() {
return attributes;
}
/**
- * Adds an attribute to those contained by this type
- * @param attribute
- */
+ * Adds an attribute to those contained by this type
+ *
+ * @param attribute
+ */
public void addAttribute(Attribute attribute) {
- attributes.add(attribute);
+ attributes.add(attribute);
}
-}
+}
\ No newline at end of file
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalComplexType.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalComplexType.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalComplexType.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalComplexType.java
Sun Jun 5 08:50:03 2005
@@ -75,7 +75,7 @@
/**
* Gets the name of this type.
- * @return
+ * @return the name of this type
*/
public String getName() {
return name;
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalElement.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalElement.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalElement.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/GlobalElement.java
Sun Jun 5 08:50:03 2005
@@ -65,7 +65,7 @@
/**
* Gets the element type
- * @return
+ * @return the type of the element
*/
public String getType() {
return type;
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/SimpleType.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/SimpleType.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/SimpleType.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/schema/SimpleType.java
Sun Jun 5 08:50:03 2005
@@ -29,7 +29,7 @@
/**
* Gets the name
- * @return
+ * @return the name of this type
*/
public String getName() {
return name;
@@ -37,7 +37,7 @@
/**
* Sets the name
- * @param string
+ * @param name
*/
public void setName(String name) {
this.name = name;
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/HyphenatedNameMapper.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/HyphenatedNameMapper.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/HyphenatedNameMapper.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/HyphenatedNameMapper.java
Sun Jun 5 08:50:03 2005
@@ -69,7 +69,7 @@
/**
* <p>The words within the bean name are deduced assuming the
- * first-letter-capital (e.g. camel's hump) naming convention. For
+ * first-letter-capital (for example camel's hump) naming convention. For
* example, the words in <code>FooBar</code> are <code>foo</code>
* and <code>bar</code>.</p>
*
@@ -134,9 +134,11 @@
}
/**
- * Should the bean name be converted to upper case?
+ * <p>Should the bean name be converted to upper case?
+ * </p>
+ * <p>
* Otherwise, it will be converted to lower case.
- *
+ * </p>
* @return whether upper or lower case conversions should be performed,
* which defaults to false for lower case
*/
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/IdStoringStrategy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/IdStoringStrategy.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/IdStoringStrategy.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/IdStoringStrategy.java
Sun Jun 5 08:50:03 2005
@@ -41,7 +41,7 @@
* Retrieves a reference for the given instance.
* If a not null value is returned from this method,
* then the bean content will not be written.
- * Use [EMAIL PROTECTED] IDGenerator} strategy to vary the values
+ * Use [EMAIL PROTECTED] org.apache.commons.betwixt.io.IDGenerator}
strategy to vary the values
* written for a bean.
*
* @param context
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/ListedClassNormalizer.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/ListedClassNormalizer.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/ListedClassNormalizer.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/ListedClassNormalizer.java
Sun Jun 5 08:50:03 2005
@@ -70,7 +70,7 @@
/**
* Adds the given substitute to the list.
- * This is a convenience method useful when [EMAIL PROTECTED]
isStrickCheck} is false.
+ * This is a convenience method useful when [EMAIL PROTECTED]
#isStrickCheck} is false.
* In this case, any subclasses (if this is a class) or implementating
classes
* if this is an interface) will be subsituted with this value.
* @param substitute sustitude this Class
Modified:
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/MixedContentEncodingStrategy.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/MixedContentEncodingStrategy.java?rev=180104&r1=180103&r2=180104&view=diff
==============================================================================
---
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/MixedContentEncodingStrategy.java
(original)
+++
jakarta/commons/proper/betwixt/branches/RELEASE_0_6_1_BRANCH/src/java/org/apache/commons/betwixt/strategy/MixedContentEncodingStrategy.java
Sun Jun 5 08:50:03 2005
@@ -23,7 +23,7 @@
* <p>Encodes body content.
* </p><p>
* <strong>Usage:</strong>
- * Used by [EMAIL PROTECTED] BeanWriter} to encode body content before it is
written
+ * Used by [EMAIL PROTECTED] org.apache.commons.betwixt.io.BeanWriter} to
encode body content before it is written
* into the textual output.
* This gives flexibility in this stage allowing (for example)
* some properties to use character escaping whilst others
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
