Author: tfischer
Date: Wed Nov 7 21:04:28 2012
New Revision: 1406804
URL: http://svn.apache.org/viewvc?rev=1406804&view=rev
Log:
- fix javadoc
- add final modifiers
- add @Override annotations
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/UnitConfiguration.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfigurationXmlParser.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/existingtargetstrategy/MergeTargetFileStrategy.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/Fileset.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/java/XmlOutlet.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/Source.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceImpl.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/FileSource.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/PropertiesSourceFormat.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/StreamSourceFormat.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceFormat.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/BeanPropertyMethodNameTransformer.java
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/GetterSetterNameTransformer.java
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/UnitConfiguration.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/UnitConfiguration.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/UnitConfiguration.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/UnitConfiguration.java
Wed Nov 7 21:04:28 2012
@@ -65,7 +65,7 @@ public class UnitConfiguration
* The base output directories for the generated files,
* keyed by the output directory key.
*/
- private Map<String, File> outputDirectoryMap = new HashMap<String, File>();
+ private final Map<String, File> outputDirectoryMap = new HashMap<String,
File>();
/**
* A directory where the Torque generator can store internal files
@@ -437,7 +437,7 @@ public class UnitConfiguration
/**
* Sets the entityReferences of the associated configuration unit.
*
- * @param options the entityReferences, not null.
+ * @param entityReferences the entityReferences, not null.
*
* @throws NullPointerException if entityReferences is null.
*/
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfigurationXmlParser.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfigurationXmlParser.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfigurationXmlParser.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfigurationXmlParser.java
Wed Nov 7 21:04:28 2012
@@ -94,8 +94,8 @@ public class OutletConfigurationXmlParse
*
* @param configurationProvider The access object for the configuration
* files, not null.
- * @param projectPaths The paths of the surrounding project, not null.
- * @param outletTypes the configured types of outlets, not null.
+ * @param configurationHandlers the handlers for reading the configuration,
+ * not null.
* @param unitDescriptor the unit descriptor, not null.
*
* @return the outlet configuration.
@@ -243,10 +243,10 @@ public class OutletConfigurationXmlParse
private static final class OutletConfigFileContent
{
/** The parsed outlets. */
- private List<Outlet> outlets;
+ private final List<Outlet> outlets;
/** The parsed isolated mergepoint mappings. */
- private List<MergepointMapping> mergepointMappings;
+ private final List<MergepointMapping> mergepointMappings;
/**
* Constructor.
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java
Wed Nov 7 21:04:28 2012
@@ -55,7 +55,7 @@ public class ControllerState
/**
* The current stack of outlets being executed.
*/
- private List<Outlet> outlets = new ArrayList<Outlet>();
+ private final List<Outlet> outlets = new ArrayList<Outlet>();
/**
* The root element of the source graph.
@@ -81,7 +81,7 @@ public class ControllerState
/**
* The variable store.
*/
- private VariableStore variableStore = new VariableStore();
+ private final VariableStore variableStore = new VariableStore();
/**
* The currently generated output file. May be null if
@@ -303,7 +303,7 @@ public class ControllerState
* The default namespace which is used when no namespace is given in
* <code>name</code> is the namespace of the currently used outlet.
*
- * @param name the object containing the name of the option,
+ * @param optionName the object containing the name of the option,
* which can contain a namespace, not null.
*
* @return The value of the option, or null if no option with that name
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/existingtargetstrategy/MergeTargetFileStrategy.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/existingtargetstrategy/MergeTargetFileStrategy.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/existingtargetstrategy/MergeTargetFileStrategy.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/existingtargetstrategy/MergeTargetFileStrategy.java
Wed Nov 7 21:04:28 2012
@@ -83,12 +83,13 @@ public class MergeTargetFileStrategy imp
* @param outputDirKey the key for the output directory
* into which the generated file should be written,
* null for the default output directory.
- * @param outputFile the location to which the output should be written.
+ * @param outputPath the location to which the output should be written.
* @param encoding The character encoding of the generated file,
* or null for the platform default encoding.
* @param generationResult the result of the generation, not null.
* @param unitConfiguration the configuration of the current configuration
* unit, not null.
+ *
* @throws GeneratorException on an error.
*/
public void afterGeneration(
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/Fileset.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/Fileset.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/Fileset.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/file/Fileset.java
Wed Nov 7 21:04:28 2012
@@ -71,7 +71,7 @@ public class Fileset
/**
* All-Args constructor.
*
- * @param the basedir, or null to use the current basedir.
+ * @param basedir the basedir, or null to use the current basedir.
* @param includes The patterns for the files to include.
* If null or empty, all Files are included.
* @param excludes The patterns for the files to exclude.
@@ -119,7 +119,8 @@ public class Fileset
/**
* Sets the include patterns for the fileset.
*
- * @return the include patterns, or null if all files should be included.
+ * @param includes the include patterns, or null if all files
+ * should be included.
*/
public void setIncludes(Collection<String> includes)
{
@@ -139,7 +140,8 @@ public class Fileset
/**
* Sets the exclude patterns for the fileset.
*
- * @return the exclude patterns, or null if all files should be excluded.
+ * @param excludes the exclude patterns, or null if all files
+ * should be excluded.
*/
public void setExcludes(Collection<String> excludes)
{
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/java/XmlOutlet.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/java/XmlOutlet.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/java/XmlOutlet.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/java/XmlOutlet.java
Wed Nov 7 21:04:28 2012
@@ -69,8 +69,8 @@ public class XmlOutlet extends OutletWit
/**
* Sets whether id attributes should be automatically created in the
output.
*
- * @param true if id attributes should be automatically created,
- * false otherwise.
+ * @param createIdAttributes true if id attributes should be automatically
+ * created, false otherwise.
*/
public void setCreateIdAttributes(boolean createIdAttributes)
{
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java
Wed Nov 7 21:04:28 2012
@@ -85,7 +85,7 @@ public final class QualifiedName
* @throws IllegalArgumentException if name has an empty name part, or
* if no namespace is found (nameOrQualifiedName has no namespace
* part and defaultNamespace is null)
- * @throw NullPointerException if name is null.
+ * @throws NullPointerException if name is null.
*/
public QualifiedName(String nameOrQualifiedName, String defaultNamespace)
{
@@ -108,7 +108,7 @@ public final class QualifiedName
* @throws IllegalArgumentException if name has an empty name part, or
* if no namespace is found (nameOrQualifiedName has no namespace
* part and defaultNamespace is null)
- * @throw NullPointerException if name is null.
+ * @throws NullPointerException if name is null.
*/
public QualifiedName(String nameOrQualifiedName, Namespace
defaultNamespace)
{
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/Source.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/Source.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/Source.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/Source.java
Wed Nov 7 21:04:28 2012
@@ -47,7 +47,6 @@ public interface Source
* Returns the source file, if it exists.
*
* @return the source file, or null if the source is not read from a file.
- * @return
*/
File getSourceFile();
}
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElement.java
Wed Nov 7 21:04:28 2012
@@ -36,22 +36,22 @@ public class SourceElement
/**
* The name of the source element.
*/
- private String name;
+ private final String name;
/**
* The parents of this element; may be empty but not null.
*/
- private List<SourceElement> parents = new ParentList(this);
+ private final List<SourceElement> parents = new ParentList(this);
/**
* All children elements.
*/
- private List<SourceElement> children = new ChildList(this);
+ private final List<SourceElement> children = new ChildList(this);
/**
* the source element's attributes.
*/
- private Map<String, Object> attributes = new HashMap<String, Object>();
+ private final Map<String, Object> attributes = new HashMap<String,
Object>();
/**
* Constructor.
@@ -72,7 +72,7 @@ public class SourceElement
/**
* Constructor.
*
- * @param name sourceElementName name of the element, not null.
+ * @param sourceElementName sourceElementName name of the element, not
null.
*
* @throws NullPointerException if sourceElementName is null.
*/
@@ -642,10 +642,10 @@ public class SourceElement
private static class ChildList extends AbstractList<SourceElement>
{
/** The source element to which this child list belongs, not null. */
- private SourceElement sourceElement;
+ private final SourceElement sourceElement;
/** The children list, not null. */
- private List<SourceElement> children
+ private final List<SourceElement> children
= new ArrayList<SourceElement>();
/**
@@ -731,10 +731,10 @@ public class SourceElement
private static class ParentList extends AbstractList<SourceElement>
{
/** The source element to which this parent list belongs, not null. */
- private SourceElement sourceElement;
+ private final SourceElement sourceElement;
/** The parent list, not null. */
- private List<SourceElement> parents
+ private final List<SourceElement> parents
= new ArrayList<SourceElement>();
/**
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceImpl.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceImpl.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceImpl.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceImpl.java
Wed Nov 7 21:04:28 2012
@@ -22,7 +22,7 @@ package org.apache.torque.generator.sour
/**
* The base implementation of the source interface.
*
- * @version: $Id$
+ * @version $Id$
*/
public abstract class SourceImpl implements Source
{
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/FileSource.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/FileSource.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/FileSource.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/FileSource.java
Wed Nov 7 21:04:28 2012
@@ -45,24 +45,24 @@ public class FileSource extends SourceIm
/**
* The format of the file, e.g. properties or XML, not null.
*/
- private StreamSourceFormat format;
+ private final StreamSourceFormat format;
/**
* The path of the file, not null.
*/
- private File path;
+ private final File path;
/**
* The controller state, not null.
*/
- private ControllerState controllerState;
+ private final ControllerState controllerState;
/**
* Constructor.
*
* @param format the source format, not null.
* @param path the path to the file to read, not null.
- * @param ControllerState the controller state, not null.
+ * @param controllerState the controller state, not null.
*
* @throws NullPointerException if path or format is null.
*/
@@ -179,14 +179,12 @@ public class FileSource extends SourceIm
* Returns the source file, if it exists.
*
* @return the source file, or null if the source is not read from a file.
- * @return
*/
public File getSourceFile()
{
return path;
}
-
@Override
public String toString()
{
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/PropertiesSourceFormat.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/PropertiesSourceFormat.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/PropertiesSourceFormat.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/PropertiesSourceFormat.java
Wed Nov 7 21:04:28 2012
@@ -84,7 +84,7 @@ public final class PropertiesSourceForma
* created element tree.
*
* @param inputStream the input stream to parse, not null.
- * @param ControllerState the controller state.
+ * @param controllerState the controller state.
*
* @return the root element of the created tree, not null.
*
@@ -173,6 +173,7 @@ public final class PropertiesSourceForma
/**
* {@inheritDoc}
*/
+ @Override
public String toString()
{
return getClass().getSimpleName();
@@ -195,7 +196,7 @@ public final class PropertiesSourceForma
* The ordered set of keys.
*/
@SuppressWarnings("unchecked")
- private Set<String> keySet = new ListOrderedSet();
+ private final Set<String> keySet = new ListOrderedSet();
@Override
public Object put(Object key, Object value)
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/StreamSourceFormat.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/StreamSourceFormat.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/StreamSourceFormat.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/StreamSourceFormat.java
Wed Nov 7 21:04:28 2012
@@ -52,7 +52,7 @@ public interface StreamSourceFormat
* Parses a source file and returns its root element.
*
* @param inputStream the stream to read the source file from, not null.
- * @param ControllerState the controller state, not null.
+ * @param controllerState the controller state, not null.
*
* @return the root element of the source, containing the rest of
* the source as linked elements.
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceFormat.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceFormat.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceFormat.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/stream/XmlSourceFormat.java
Wed Nov 7 21:04:28 2012
@@ -102,7 +102,7 @@ public final class XmlSourceFormat imple
* hierarchy from it.
*
* @param xmlStream the stream containing the xml data, not null.
- * @param ControllerState the controller state, not null.
+ * @param controllerState the controller state, not null.
*
* @return the root element of the created hierarchy.
*
@@ -191,6 +191,7 @@ public final class XmlSourceFormat imple
/**
* {@inheritDoc}
*/
+ @Override
public String toString()
{
return getClass().getSimpleName();
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/BeanPropertyMethodNameTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/BeanPropertyMethodNameTransformer.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/BeanPropertyMethodNameTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/BeanPropertyMethodNameTransformer.java
Wed Nov 7 21:04:28 2012
@@ -42,7 +42,7 @@ public class BeanPropertyMethodNameTrans
= Logger.getLogger(BeanPropertyMethodNameTransformer.class);
/** The camelbacker used to convert the input string. */
- private Camelbacker camelbacker = new Camelbacker();
+ private final Camelbacker camelbacker = new Camelbacker();
/** The prefix which is added in front of the input string. */
private String prefix = "";
@@ -98,7 +98,7 @@ public class BeanPropertyMethodNameTrans
/**
* Sets the suffix which is added after of the input string.
*
- * @param prefix the suffix for the result, not null.
+ * @param suffix the suffix for the result, not null.
*
* @throws NullPointerException if suffix is null.
*/
@@ -118,6 +118,7 @@ public class BeanPropertyMethodNameTrans
*
* @throws IllegalStateException if targetAttributeName was not set.
*/
+ @Override
public SourceElement transform(
SourceElement sourceElement,
ControllerState controllerState)
Modified:
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/GetterSetterNameTransformer.java
URL:
http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/GetterSetterNameTransformer.java?rev=1406804&r1=1406803&r2=1406804&view=diff
==============================================================================
---
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/GetterSetterNameTransformer.java
(original)
+++
db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/GetterSetterNameTransformer.java
Wed Nov 7 21:04:28 2012
@@ -127,7 +127,7 @@ public class GetterSetterNameTransformer
/**
* Sets the name of the target element attribute for the setter name.
*
- * @param getterNameAttribute the name of the setter name target attribute,
+ * @param setterNameAttribute the name of the setter name target attribute,
* not null.
*
* @throws NullPointerException if setterNameAttribute is null.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
