Author: jmitchell
Date: Tue Sep 6 21:22:29 2005
New Revision: 279242
URL: http://svn.apache.org/viewcvs?rev=279242&view=rev
Log:
Here are a few annoyance fixes that should make javadoc happy:
* remove some unused imports
* change static access to direct references
* add a bunch of javadoc (@param, @return, etc)
I hope these kinds of updates aren't too much noise. I'm almost done - I
promise.
I haven't verified the 'fix me' -> '@todo' tag changes yet
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTags.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTagsTask.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/XDocletParser.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapper.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapping.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ServletActionMapper.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/ActionMessage.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/URLCodec.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/Factory.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryConfig.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryUtils.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/FreezableMutableURI.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/MutableURI.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/TemplatedURLFormatter.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URIContext.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriter.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriterService.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLType.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/TemplateTokenizer.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/URLTemplate.java
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/servlet/StrutsTiServlet.java
struts/sandbox/trunk/ti/project.xml
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTags.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTags.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTags.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTags.java
Tue Sep 6 21:22:29 2005
@@ -35,8 +35,10 @@
private static final Log log = LogFactory.getLog(ProcessTags.class);
- // TODO where is this used?
- private static final String SEP = File.separator;
+ /**
+ * @todo Where is this being (or will it be) used?
+ */
+// private static final String SEP = File.separator;
/**
* Set the parser
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTagsTask.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTagsTask.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTagsTask.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/ProcessTagsTask.java
Tue Sep 6 21:22:29 2005
@@ -33,21 +33,34 @@
*/
public class ProcessTagsTask {
- private ProcessTags processTags;
private File srcdir;
private File destdir;
private static final Log log = LogFactory.getLog(ProcessTagsTask.class);
- public void setSrcdir(File file) {
- this.srcdir = file;
- }
-
- public void setDestdir(File file) {
- this.destdir = file;
- }
- public void execute() {
+ /**
+ * @param destdir The destdir to set.
+ */
+ public void setDestdir(File destdir) {
+ this.destdir = destdir;
+ }
+
+
+ /**
+ * @param srcdir The srcdir to set.
+ */
+ public void setSrcdir(File srcdir) {
+ this.srcdir = srcdir;
+ }
+
+
+ /**
+ *
+ *
+ */
+ public void execute() {
+ log.debug("ProcessTagsTask#execute()");
VelocityTemplateProcessor proc = new VelocityTemplateProcessor();
proc.init();
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/XDocletParser.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/XDocletParser.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/XDocletParser.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/XDocletParser.java
Tue Sep 6 21:22:29 2005
@@ -17,16 +17,12 @@
*/
package org.apache.ti.config;
-import java.io.Reader;
import java.io.Writer;
import java.io.File;
-import java.io.FileWriter;
-import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Iterator;
import java.util.List;
-import java.util.Properties;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
@@ -34,7 +30,6 @@
import xjavadoc.XClass;
import xjavadoc.XMethod;
import xjavadoc.XJavaDoc;
-import xjavadoc.filesystem.ReaderFile;
import xjavadoc.filesystem.XJavadocFile;
import org.apache.ti.util.*;
@@ -46,22 +41,45 @@
public class XDocletParser {
private Map parameters;
- private TemplateProcessor processor;
+ private TemplateProcessor templateProcessor;
private static final Log log = LogFactory.getLog(XDocletParser.class);
- public void setTemplateProcessor(TemplateProcessor p) {
- this.processor = p;
- }
-
- public void setParameters(Map map) {
- this.parameters = map;
- }
- public Map getParameters() {
- return parameters;
- }
+ /**
+ * @return Returns the parameters.
+ */
+ public Map getParameters() {
+ return parameters;
+ }
+
+
+ /**
+ * @param parameters The parameters to set.
+ */
+ public void setParameters(Map parameters) {
+ this.parameters = parameters;
+ }
+
+
+
+
+ /**
+ * @return Returns the templateProcessor.
+ */
+ public TemplateProcessor getTemplateProcessor() {
+ return templateProcessor;
+ }
+
+
+ /**
+ * @param templateProcessor The templateProcessor to set.
+ */
+ public void setTemplateProcessor(TemplateProcessor templateProcessor) {
+ this.templateProcessor = templateProcessor;
+ }
+
- protected String getClassName(String uri) {
+ protected String getClassName(String uri) {
String className = uri.replace('/', '.');
className = className.replace('\\', '.');
className = className.substring(0, className.indexOf(".java"));
@@ -69,7 +87,16 @@
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param sources
+ * @param srcRoot
+ * @param destRoot
+ * @param outputs
+ */
public void generate(List sources, File srcRoot, File destRoot, List
outputs) {
+ log.debug("XDocletParser#generate()");
XJavaDoc jdoc = new XJavaDoc();
String source, className;
XJavadocFile file;
@@ -89,16 +116,16 @@
XClass xclass;
for (Iterator o = outputs.iterator(); o.hasNext(); ) {
output = (OutputType)o.next();
- if (output.getFrequency() == output.ONCE) {
+ if (output.getFrequency() == OutputType.ONCE) {
generateOnce(sources, destRoot, jdoc, output, context);
} else {
for (Iterator i = sources.iterator(); i.hasNext(); ) {
source = (String)i.next();
xclass = jdoc.getXClass(getClassName(source));
- if (output.getFrequency() == output.PER_CONTROLLER) {
+ if (output.getFrequency() == OutputType.PER_CONTROLLER) {
generatePerController(source, destRoot, xclass,
output, context);
- } else if (output.getFrequency() == output.PER_ACTION) {
+ } else if (output.getFrequency() == OutputType.PER_ACTION)
{
generatePerAction(source, destRoot, xclass, output,
context);
}
}
@@ -119,7 +146,7 @@
}
Writer writer = output.getWriter(destRoot, null, null);
context.put("xclasses", xclasses);
- processor.process(output.getTemplate(), context, writer);
+ templateProcessor.process(output.getTemplate(), context, writer);
}
@@ -129,7 +156,7 @@
Writer writer = output.getWriter(destRoot, source, null);
context.put("xclass", xclass);
context.put("javaFile", source);
- processor.process(output.getTemplate(), context, writer);
+ templateProcessor.process(output.getTemplate(), context, writer);
}
@@ -146,7 +173,7 @@
context.put("xmethod", m);
context.put("javaFile", source);
- processor.process(output.getTemplate(), context, writer);
+ templateProcessor.process(output.getTemplate(), context,
writer);
}
}
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapper.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapper.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapper.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapper.java
Tue Sep 6 21:22:29 2005
@@ -23,7 +23,21 @@
* Handles creation of ActionMapping and reconstruction of URI's from one.
*/
public interface ActionMapper {
+
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param ctx
+ * @return Returns an ActionMapping
+ */
ActionMapping getMapping(WebContext ctx);
+ /**
+ * @todo Finish documenting me!
+ * @todo Why does getUri*() return a String and not a Uri?
+ *
+ * @param mapping
+ * @return Returns the (encoded?) Uri (String) from the ActionMapping
+ */
String getUriFromActionMapping(ActionMapping mapping);
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapping.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapping.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapping.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ActionMapping.java
Tue Sep 6 21:22:29 2005
@@ -20,7 +20,7 @@
import java.util.Map;
/**
- * Simple class that holds the action mapping information used to invoke an
+ * Simple immutable class that holds the action mapping information used to
invoke an
* action. The name and namespace are required, but the params map
* is optional, and as such may be null. If a params map is supplied,
* it <b>must</b> be a mutable map, such as a HashMap.
@@ -33,6 +33,14 @@
private String namespace;
private Map params;
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param name
+ * @param namespace
+ * @param extMapping
+ * @param params
+ */
public ActionMapping(String name, String namespace, String extMapping, Map
params) {
this.name = name;
this.namespace = namespace;
@@ -40,19 +48,32 @@
this.externalMapping = extMapping;
}
- public String getName() {
- return name;
- }
+ /**
+ * @return Returns the externalMapping.
+ */
+ public String getExternalMapping() {
+ return externalMapping;
+ }
- public String getNamespace() {
- return namespace;
- }
+ /**
+ * @return Returns the name.
+ */
+ public String getName() {
+ return name;
+ }
- public Map getParams() {
- return params;
- }
+ /**
+ * @return Returns the namespace.
+ */
+ public String getNamespace() {
+ return namespace;
+ }
+
+ /**
+ * @return Returns the params.
+ */
+ public Map getParams() {
+ return params;
+ }
- public String getExternalMapping() {
- return externalMapping;
- }
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ServletActionMapper.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ServletActionMapper.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ServletActionMapper.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/config/mapper/ServletActionMapper.java
Tue Sep 6 21:22:29 2005
@@ -36,6 +36,14 @@
protected static final Log log =
LogFactory.getLog(ServletActionMapper.class);
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param ctx The [EMAIL PROTECTED] WebContext} for this request.
+ *
+ * @return The current [EMAIL PROTECTED] ActionMapping} for this context
or null if
+ * not found.
+ */
public ActionMapping getMapping(WebContext ctx) {
HttpServletRequest request = ((ServletWebContext) ctx).getRequest();
@@ -86,6 +94,12 @@
}
}
+ /**
+ * @todo Isn't this duplicate somewhere else?
+ *
+ * @param mapping The mapping to check
+ * @return The uri for the specified action mapping
+ */
public String getUriFromActionMapping(ActionMapping mapping) {
String ext = mapping.getExternalMapping();
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/ActionMessage.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/ActionMessage.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/ActionMessage.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/ActionMessage.java
Tue Sep 6 21:22:29 2005
@@ -19,6 +19,10 @@
import java.io.Serializable;
+/**
+ *
+ * @todo Finish documenting me!
+ */
public class ActionMessage implements Serializable {
@@ -122,7 +126,9 @@
/**
- * <p>Get the message key for this message.</p>
+ * <p>Get the message key for this message.</p>
+ * @return The message key for this message.
+ *
*/
public String getKey() {
@@ -133,6 +139,8 @@
/**
* <p>Get the replacement values for this message.</p>
+ *
+ * @return Get the replacement values for this message.
*/
public Object[] getValues() {
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/URLCodec.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/URLCodec.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
--- struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/URLCodec.java
(original)
+++ struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/URLCodec.java
Tue Sep 6 21:22:29 2005
@@ -37,6 +37,7 @@
* @param decoded the string to encode
* @param charset the character set to use
* @return the encoded string
+ * @throws UnsupportedEncodingException In the event of an error.
*/
public static String encode(final String decoded, final String charset)
throws UnsupportedEncodingException {
@@ -63,6 +64,7 @@
* @param encoded the string to decode
* @param charset the character set to use
* @return the decoded string
+ * @throws UnsupportedEncodingException In the event of an error.
*/
public static String decode(final String encoded, final String charset)
throws UnsupportedEncodingException {
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/Factory.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/Factory.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/Factory.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/Factory.java
Tue Sep 6 21:22:29 2005
@@ -27,7 +27,7 @@
public abstract class Factory
implements Serializable {
- private static final Logger _log = Logger.getInstance(Factory.class);
+ private static final Logger log = Logger.getInstance(Factory.class);
private FactoryConfig _config;
@@ -35,6 +35,7 @@
* Called after this factory has been created and initialized.
*/
protected void onCreate() {
+ log.debug("Factory#create()");
}
void init(FactoryConfig config) {
@@ -45,12 +46,17 @@
* Called to reinitialize this instance, most importantly after it has
been serialized/deserialized.
*/
protected void reinit() {
+ log.debug("Factory#reinit()");
}
/**
+ * @todo Finish documenting me!
+ *
* Get the configuration object (containing custom properties) that is
associated with this factory.
+ * @return A [EMAIL PROTECTED] FactoryConfig} or null
*/
protected FactoryConfig getConfig() {
+ log.debug("Factory#getConfig()");
return _config;
}
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryConfig.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryConfig.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryConfig.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryConfig.java
Tue Sep 6 21:22:29 2005
@@ -34,6 +34,13 @@
_customProperties.put(name, value);
}
+ /**
+ *
+ * @todo Finish documenting me!
+ *
+ * @param name The custom property name
+ * @return The value for the specified name
+ */
public String getCustomProperty(String name) {
return _customProperties != null ? (String)
_customProperties.get(name) : null;
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryUtils.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryUtils.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryUtils.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/factory/FactoryUtils.java
Tue Sep 6 21:22:29 2005
@@ -29,6 +29,13 @@
private static final Logger _log = Logger.getInstance(FactoryUtils.class);
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param factoryBean
+ * @param factoryType
+ * @return The factory specified
+ */
public static Factory getFactory(PageflowFactory factoryBean, Class
factoryType) {
if (factoryBean == null) return null;
@@ -62,6 +69,13 @@
return null;
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param factoryType
+ * @param config
+ * @return FIX ME
+ */
public static Factory getFactory(Class factoryType, FactoryConfig config) {
assert Factory.class.isAssignableFrom(factoryType) :
factoryType.getClass().getName();
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/FreezableMutableURI.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/FreezableMutableURI.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/FreezableMutableURI.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/FreezableMutableURI.java
Tue Sep 6 21:22:29 2005
@@ -23,9 +23,12 @@
import java.util.Map;
/**
+ * @todo Finish documenting me!
+ *
* A mutable class for creating URIs that can be set to "frozen" such
* that it becomes immutable. After this class is frozen, any calls to
- * methods to set the data components of the URI will throw
+ * methods to set the data components of the URI will throw ???
+ *
*/
public class FreezableMutableURI extends MutableURI {
@@ -35,14 +38,18 @@
* Constructs a <code>FreezableMutableURI</code>.
*/
public FreezableMutableURI() {
+ // @todo Fix me
}
/**
+ * @todo Finish documenting me!
+ *
* Constructs a <code>FreezableMutableURI</code>.
*
* @param uriString the string to be parsed into a URI
* @param encoded Flag indicating whether the string is
* already encoded.
+ * @throws URISyntaxException
*/
public FreezableMutableURI(String uriString, boolean encoded) throws
URISyntaxException {
super(uriString, encoded);
@@ -93,6 +100,11 @@
super(url);
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * @return Return the state of this URI
+ */
public final boolean isFrozen() {
return _frozen;
}
@@ -113,6 +125,8 @@
}
/**
+ * @todo Finish documenting me!
+ *
* Reset the value of the <code>FreezableMutableURI</code>.
* <p/>
* <p> This method can also be used to clear the
<code>FreezableMutableURI</code>.
@@ -120,6 +134,8 @@
* @param uriString the string to be parsed into a URI
* @param encoded Flag indicating whether the string is
* already encoded.
+ *
+ * @throws URISyntaxException When something bad happens
*/
public void setURI(String uriString, boolean encoded) throws
URISyntaxException {
@@ -269,6 +285,15 @@
super.setFragment(fragment);
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * Custom equals implementation.
+ *
+ * @param o The object to check against
+ *
+ * @return Whether this object is logically equal to the parameter passed
to it.
+ */
public boolean equals(Object o) {
if (this == o) {
return true;
@@ -289,6 +314,11 @@
return true;
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * @return Return
+ */
public int hashCode() {
int result = super.hashCode();
result = 29 * result + (_frozen ? 1 : 0);
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/MutableURI.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/MutableURI.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/MutableURI.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/MutableURI.java
Tue Sep 6 21:22:29 2005
@@ -120,17 +120,24 @@
Collections.unmodifiableMap(new HashMap/*< String, List< String >
>*/());
/**
+ * @todo Finish documenting me!
+ *
* Constructs a <code>MutableURI</code>.
*/
public MutableURI() {
+ // @todo fix me
}
/**
+ * @todo Finish documenting me!
+ *
* Constructs a <code>MutableURI</code>.
*
* @param uriString the string to be parsed into a URI
* @param encoded Flag indicating whether the string is
* already encoded.
+ *
+ * @throws URISyntaxException When something bad happens
*/
public MutableURI(String uriString, boolean encoded) throws
URISyntaxException {
assert uriString != null : "The uri cannot be null.";
@@ -217,6 +224,8 @@
}
/**
+ * @todo Finish documenting me!
+ *
* Set the value of the <code>MutableURI</code>.
* <p/>
* <p> This method can also be used to clear the <code>MutableURI</code>.
</p>
@@ -224,6 +233,8 @@
* @param uriString the string to be parsed into a URI
* @param encoded Flag indicating whether the string is
* already encoded.
+ *
+ * @throws URISyntaxException When something bad happens.
*/
public void setURI(String uriString, boolean encoded) throws
URISyntaxException {
if (uriString == null) {
@@ -804,6 +815,7 @@
try {
encodedURL = URLCodec.encode(url, DEFAULT_ENCODING);
} catch (java.io.UnsupportedEncodingException ignore) {
+ // ignore
}
}
return encodedURL;
@@ -887,6 +899,7 @@
* its URI class.
*
* @param original the original character sequence
+ * @return A URI from the given (original) String
* @throws URISyntaxException If an error occurs.
*/
protected static URI encodeURI(String original) throws URISyntaxException {
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/TemplatedURLFormatter.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/TemplatedURLFormatter.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/TemplatedURLFormatter.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/TemplatedURLFormatter.java
Tue Sep 6 21:22:29 2005
@@ -63,11 +63,34 @@
public static final String DEFAULT_TEMPLATE_REF = "default-url-templates";
// Base set of tokens
+ /**
+ * @todo Finish documenting me!
+ */
public static final String SCHEME_TOKEN = "{url:scheme}";
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final String DOMAIN_TOKEN = "{url:domain}";
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final String PORT_TOKEN = "{url:port}";
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final String PATH_TOKEN = "{url:path}";
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final String QUERY_STRING_TOKEN = "{url:queryString}";
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final String FRAGMENT_TOKEN = "{url:fragment}";
private List _knownTokens =
@@ -85,6 +108,14 @@
return (TemplatedURLFormatter)
PageFlowActionContext.get().getApplication().get(TEMPLATED_URL_FORMATTER_ATTR);
}
+ /**
+ * @todo Finish documenting me!
+ *
+ * @param applicationScope
+ * @param defaultFormatter
+ *
+ * @return The [EMAIL PROTECTED] TemplatedURLFormatter} for this
configuration.
+ */
public static TemplatedURLFormatter initApplication(Map applicationScope,
TemplatedURLFormatter defaultFormatter) {
// get the default template formatter class name from the config file
TemplatedURLFormatter formatter = createTemplatedURLFormatter();
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URIContext.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URIContext.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URIContext.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URIContext.java
Tue Sep 6 21:22:29 2005
@@ -32,6 +32,7 @@
* Constructs a <code>URIContext</code>.
*/
public URIContext() {
+ // do nothing
}
/**
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriter.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriter.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriter.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriter.java
Tue Sep 6 21:22:29 2005
@@ -30,10 +30,18 @@
*/
private boolean _allowOtherRewriters = true;
+ /**
+ * Set the switch to allow other rewriters
+ * @param allowOtherRewriters
+ */
public void setAllowOtherRewriters(boolean allowOtherRewriters) {
_allowOtherRewriters = allowOtherRewriters;
}
+ /**
+ * Get the state of the allow other rewriters switch.
+ * @return true if allowed, false if not
+ */
public boolean allowOtherRewriters() {
return _allowOtherRewriters;
}
@@ -61,9 +69,13 @@
public abstract void rewriteURL(MutableURI url, URLType type, boolean
needsToBeSecure);
/**
+ * @todo Finish documenting me!
+ *
* Tell whether rewritten form actions should be allowed to have query
parameters. If this returns
* <code>false</code>, then a form-tag implementation should render query
parameters into hidden
* fields on the form instead of allowing them to remain in the URL.
+ *
+ * @return Return true if allowed, false if not
*/
public boolean allowParamsOnFormAction() {
return false;
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriterService.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriterService.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriterService.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLRewriterService.java
Tue Sep 6 21:22:29 2005
@@ -223,10 +223,12 @@
}
/**
+ * @todo Finish documenting me!
+ *
* Unregister the URLRewriter (remove from the list) from the request.
*
* @param rewriter the URLRewriter to unregister
- * @see #registerURLRewriter
+ * @todo fix this -- @ see #registerURLRewriter (ambiguous reference)
*/
public static void unregisterURLRewriter(URLRewriter rewriter) {
if (rewriter == null) {
@@ -257,6 +259,8 @@
* Tell whether rewritten form actions should be allowed to have query
parameters. If this returns
* <code>false</code>, then a form-tag implementation should render query
parameters into hidden
* fields on the form instead of allowing them to remain in the URL.
+ *
+ * @return Return true if allowed, false if not.
*/
public static boolean allowParamsOnFormAction() {
ArrayList/*< URLRewriter >*/ rewriters = getRewriters();
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLType.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLType.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLType.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urls/URLType.java
Tue Sep 6 21:22:29 2005
@@ -26,7 +26,14 @@
protected static final int INT_ACTION = 0;
protected static final int INT_RESOURCE = 1;
+ /**
+ * @todo Finish documenting me!
+ */
public static final URLType ACTION = new URLType(INT_ACTION);
+
+ /**
+ * @todo Finish documenting me!
+ */
public static final URLType RESOURCE = new URLType(INT_RESOURCE);
private int _val;
@@ -35,6 +42,9 @@
_val = val;
}
+ /**
+ * @see Object#toString()
+ */
public String toString() {
switch (_val) {
case INT_ACTION:
@@ -46,7 +56,11 @@
assert false : _val;
return "<unknown URLType>";
}
+
+ /**
+ * @see Object#equals(java.lang.Object)
+ */
public boolean equals(Object o) {
if (o == null) return false;
if (o == this) return true;
@@ -54,6 +68,9 @@
return ((URLType) o)._val == _val;
}
+ /**
+ * @see Object#hashCode()
+ */
public int hashCode() {
return _val;
}
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/TemplateTokenizer.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/TemplateTokenizer.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/TemplateTokenizer.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/TemplateTokenizer.java
Tue Sep 6 21:22:29 2005
@@ -43,13 +43,20 @@
// returned at the next call to next()
private String _literal;
+ /**
+ * @todo Finish documenting me!
+ *
+ * Constructor that takes a [EMAIL PROTECTED] CharSequence}
+ * @param template
+ */
public TemplateTokenizer(CharSequence template) {
_template = template;
_matcher = pattern.matcher(_template);
}
/**
- * Returns true if there are more literals or tokens/delimiters.
+ * @return Returns true if there are more literals or tokens/delimiters.
+ * @see Iterator#hasNext()
*/
public boolean hasNext() {
if (_matcher == null) {
@@ -75,6 +82,7 @@
/**
* Returns the next literal string or token/delimiter.
+ * @see Iterator#next()
*/
public Object next() {
String result = null;
@@ -90,8 +98,11 @@
}
/**
+ * @todo Finish documenting me!
+ *
* Returns true if the call to next() will return a token rather
* than a literal.
+ * @return Fix me
*/
public boolean isTokenNext() {
return _literal == null && _token != null;
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/URLTemplate.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/URLTemplate.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/URLTemplate.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/core/urltemplates/URLTemplate.java
Tue Sep 6 21:22:29 2005
@@ -98,6 +98,8 @@
}
/**
+ * @todo Finish documenting me!
+ *
* Verification will ensure the URL template conforms to a valid format
* for known tokens and contains the required tokens. It will also parse
* the tokens and literal data into a list to improve the replacement
@@ -114,6 +116,8 @@
*
* @param knownTokens the collection of known tokens (Strings) for a
valid template.
* @param requiredTokens the collection of required tokens (Strings) in a
valid template.
+ *
+ * @throws IllegalStateException When ???
*/
public void verify(Collection knownTokens, Collection requiredTokens)
throws IllegalStateException {
// For each known token, make sure there is a leading and trailing
brace
@@ -185,6 +189,8 @@
/**
* Replace a single token in the template with a corresponding String
value.
* Tokens are expected to be qualified in braces. E.g. {url:path}
+ * @param token The token to use in the template
+ * @param value The replacement value
*/
public void substitute(String token, String value) {
_tokenValuesMap.put(token, value);
@@ -193,6 +199,8 @@
/**
* Replace a single token in the template with a corresponding int value.
* Tokens are expected to be qualified in braces. E.g. {url:port}
+ * @param token The token to use in the template
+ * @param value The replacement value
*/
public void substitute(String token, int value) {
String valueStr = Integer.toString(value);
Modified:
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/servlet/StrutsTiServlet.java
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/servlet/StrutsTiServlet.java?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
---
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/servlet/StrutsTiServlet.java
(original)
+++
struts/sandbox/trunk/ti/jars/core/src/java/org/apache/ti/servlet/StrutsTiServlet.java
Tue Sep 6 21:22:29 2005
@@ -99,13 +99,15 @@
*/
public void addServletMapping(String servletName, String urlPattern) {
+ String myServletName = getServletConfig().getServletName();
+
+ boolean matches = servletName != null &&
servletName.equals(myServletName);
if (log.isDebugEnabled()) {
log.debug("Process servletName=" + servletName
- + ", urlPattern=" + urlPattern);
+ + ", urlPattern=" + urlPattern
+ + (matches ? "(is a match)" : "(not a match)"));
}
- String myServletName = getServletConfig().getServletName();
-
- if (servletName != null && servletName.equals(myServletName)) {
+ if (matches) {
servletMappings.add(urlPattern);
}
Modified: struts/sandbox/trunk/ti/project.xml
URL:
http://svn.apache.org/viewcvs/struts/sandbox/trunk/ti/project.xml?rev=279242&r1=279241&r2=279242&view=diff
==============================================================================
--- struts/sandbox/trunk/ti/project.xml (original)
+++ struts/sandbox/trunk/ti/project.xml Tue Sep 6 21:22:29 2005
@@ -97,6 +97,13 @@
<organization></organization>
</developer>
+ <developer>
+ <name>James Mitchell</name>
+ <id>jmitchell</id>
+ <email>jmitchell at apache.org</email>
+ <organization>EdgeTech, Inc.</organization>
+ </developer>
+
</developers>
<contributors/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
