TILESSB-38
Fixed tiles-autotag-freemarker-runtime checkstyle.
git-svn-id: https://svn.apache.org/repos/asf/tiles/sandbox/trunk/tiles-autotag@1045329 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModel.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModel.java
index 85e0714..01f67c8 100644
--- a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModel.java
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModel.java
@@ -1,3 +1,23 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
import java.io.IOException;
@@ -13,6 +33,11 @@
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateModel;
+/**
+ * Base directive model for models with a body.
+ *
+ * @version $Rev$ $Date$
+ */
public abstract class BodyFMModel implements TemplateDirectiveModel {
@SuppressWarnings("unchecked")
@@ -25,6 +50,14 @@
execute(params, request, modelBody);
}
+ /**
+ * Executes the model.
+ *
+ * @param parms Parameters.
+ * @param request The request.
+ * @param modelBody The body.
+ * @throws IOException If something goes wrong.
+ */
protected abstract void execute(Map<String, TemplateModel> parms,
Request request, ModelBody modelBody) throws IOException;
}
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModel.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModel.java
index 3c461cd..5b1fbb7 100644
--- a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModel.java
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModel.java
@@ -1,3 +1,23 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
import java.io.IOException;
@@ -12,6 +32,11 @@
import freemarker.template.TemplateDirectiveModel;
import freemarker.template.TemplateModel;
+/**
+ * Base directive model for models with a body.
+ *
+ * @version $Rev$ $Date$
+ */
public abstract class BodylessFMModel implements TemplateDirectiveModel {
@SuppressWarnings("unchecked")
@@ -23,6 +48,13 @@
execute(params, request);
}
+ /**
+ * Executes the model.
+ *
+ * @param parms Parameters.
+ * @param request The request.
+ * @throws IOException If something goes wrong.
+ */
protected abstract void execute(Map<String, TemplateModel> parms,
Request request) throws IOException;
}
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagException.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagException.java
index 625b63a..6f11f10 100644
--- a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagException.java
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagException.java
@@ -1,18 +1,62 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
+/**
+ * Thrown when a Freemarker problem under Autotag runtime part happens.
+ *
+ * @version $Rev$ $Date$
+ */
public class FreemarkerAutotagException extends RuntimeException {
+ /**
+ * Constructor.
+ */
public FreemarkerAutotagException() {
}
+ /**
+ * Constructor.
+ *
+ * @param message The message of the exception.
+ */
public FreemarkerAutotagException(String message) {
super(message);
}
+ /**
+ * Constructor.
+ *
+ * @param cause The cause.
+ */
public FreemarkerAutotagException(Throwable cause) {
super(cause);
}
+ /**
+ * Constructor.
+ *
+ * @param message The message of the exception.
+ * @param cause The cause.
+ */
public FreemarkerAutotagException(String message, Throwable cause) {
super(message, cause);
}
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBody.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBody.java
index 0341b22..13c5e84 100644
--- a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBody.java
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBody.java
@@ -1,3 +1,23 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
import java.io.IOException;
@@ -8,10 +28,24 @@
import freemarker.template.TemplateDirectiveBody;
import freemarker.template.TemplateException;
+/**
+ * Body implementation of a Freemarker model body.
+ *
+ * @version $Rev$ $Date$
+ */
public class FreemarkerModelBody extends AbstractModelBody {
+ /**
+ * The real body.
+ */
private TemplateDirectiveBody templateDirectiveBody;
+ /**
+ * Constructor.
+ *
+ * @param defaultWriter The default writer.
+ * @param templateDirectiveBody The real body.
+ */
public FreemarkerModelBody(Writer defaultWriter, TemplateDirectiveBody templateDirectiveBody) {
super(defaultWriter);
this.templateDirectiveBody = templateDirectiveBody;
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtil.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtil.java
index 19ccb3c..6f50038 100644
--- a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtil.java
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtil.java
@@ -43,6 +43,8 @@
* Unwraps a TemplateModel to extract an object.
*
* @param model The TemplateModel to unwrap.
+ * @param defaultValue The default value, as specified in the template
+ * model, or null if not specified.
* @return The unwrapped object.
* @since 3.0.0
*/
diff --git a/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/package-info.java b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/package-info.java
new file mode 100644
index 0000000..0cb0f7e
--- /dev/null
+++ b/tiles-autotag-freemarker-runtime/src/main/java/org/apache/tiles/autotag/freemarker/runtime/package-info.java
@@ -0,0 +1,24 @@
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.
+ */
+/**
+ * Runtime part of Autotag support for Freemarker.
+ */
+package org.apache.tiles.autotag.freemarker.runtime;
diff --git a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModelTest.java b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModelTest.java
index 87a4d78..3147c33 100644
--- a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModelTest.java
+++ b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodyFMModelTest.java
@@ -1,5 +1,22 @@
-/**
+/*
+ * $Id$
*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
@@ -41,7 +58,7 @@
/**
* Test method for
- * {@link org.apache.tiles.autotag.freemarker.runtime.BodyFMModel#execute(freemarker.core.Environment, java.util.Map, freemarker.template.TemplateModel[], freemarker.template.TemplateDirectiveBody)}
+ * {@link BodyFMModel#execute(Environment, Map, TemplateModel[], TemplateDirectiveBody)}
* .
*
* @throws IOException If something goes wrong.
diff --git a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModelTest.java b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModelTest.java
index 5b863ae..70a99c7 100644
--- a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModelTest.java
+++ b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/BodylessFMModelTest.java
@@ -1,5 +1,22 @@
-/**
+/*
+ * $Id$
*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
@@ -40,7 +57,7 @@
/**
* Test method for
- * {@link org.apache.tiles.autotag.freemarker.runtime.BodylessFMModel#execute(freemarker.core.Environment, java.util.Map, freemarker.template.TemplateModel[], freemarker.template.TemplateDirectiveBody)}
+ * {@link BodylessFMModel#execute(Environment, Map, TemplateModel[], TemplateDirectiveBody)}
* .
*
* @throws IOException If something goes wrong.
diff --git a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagExceptionTest.java b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagExceptionTest.java
index 930c666..df54c3b 100644
--- a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagExceptionTest.java
+++ b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerAutotagExceptionTest.java
@@ -64,7 +64,7 @@
}
/**
- * Test method for {@link FreemarkerAutotagException#FreemarkerAutotagException(java.lang.String, java.lang.Throwable)}.
+ * Test method for {@link FreemarkerAutotagException#FreemarkerAutotagException(String, Throwable)}.
*/
@Test
public void testFreemarkerAutotagExceptionStringThrowable() {
diff --git a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBodyTest.java b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBodyTest.java
index 073bcac..cae2448 100644
--- a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBodyTest.java
+++ b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerModelBodyTest.java
@@ -1,5 +1,22 @@
-/**
+/*
+ * $Id$
*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
@@ -58,7 +75,7 @@
* @throws IOException If something goes wrong.
* @throws TemplateException If something goes wrong.
*/
- @Test(expected=IOException.class)
+ @Test(expected = IOException.class)
public void testEvaluateWriterException() throws TemplateException, IOException {
TemplateDirectiveBody body = createMock(TemplateDirectiveBody.class);
Writer writer = createMock(Writer.class);
diff --git a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtilTest.java b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtilTest.java
index f6793d8..627346e 100644
--- a/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtilTest.java
+++ b/tiles-autotag-freemarker-runtime/src/test/java/org/apache/tiles/autotag/freemarker/runtime/FreemarkerUtilTest.java
@@ -1,5 +1,22 @@
-/**
+/*
+ * $Id$
*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, 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.tiles.autotag.freemarker.runtime;
@@ -26,7 +43,7 @@
public class FreemarkerUtilTest {
/**
- * Test method for {@link org.apache.tiles.autotag.freemarker.runtime.FreemarkerUtil#getAsObject(freemarker.template.TemplateModel, java.lang.Object)}.
+ * Test method for {@link FreemarkerUtil#getAsObject(TemplateModel, Object)}.
* @throws TemplateModelException If something goes wrong.
*/
@Test
@@ -48,7 +65,7 @@
}
/**
- * Test method for {@link org.apache.tiles.autotag.freemarker.runtime.FreemarkerUtil#getAsObject(freemarker.template.TemplateModel, java.lang.Object)}.
+ * Test method for {@link FreemarkerUtil#getAsObject(TemplateModel, Object)}.
* @throws TemplateModelException If something goes wrong.
*/
@Test
@@ -67,10 +84,10 @@
}
/**
- * Test method for {@link org.apache.tiles.autotag.freemarker.runtime.FreemarkerUtil#getAsObject(freemarker.template.TemplateModel, java.lang.Object)}.
+ * Test method for {@link FreemarkerUtil#getAsObject(TemplateModel, Object)}.
* @throws TemplateModelException If something goes wrong.
*/
- @Test(expected=FreemarkerAutotagException.class)
+ @Test(expected = FreemarkerAutotagException.class)
public void testGetAsObjectException() throws TemplateModelException {
TemplateNumberModel model = createMock(TemplateNumberModel.class);
Template template = createMock(Template.class);
