refactoring of the config interface towards more reuse in the implementation and...

[xmlrouter] / config / src / main / java / org / wamblee / xmlrouter / config / DocumentType.java

diff --git a/config/src/main/java/org/wamblee/xmlrouter/config/DocumentType.java b/config/src/main/java/org/wamblee/xmlrouter/config/DocumentType.java
index 9b04ec6122e69d37956c5c0ef5321db554e76498..4ffc5f83bdc07e1a74c6e4dc86d629a97019c7a4 100644 (file)
--- a/config/src/main/java/org/wamblee/xmlrouter/config/DocumentType.java
+++ b/config/src/main/java/org/wamblee/xmlrouter/config/DocumentType.java
@@ -12,31 +12,43 @@
  * 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.wamblee.xmlrouter.config;
 
 import javax.xml.transform.dom.DOMSource;
 
+/**
+ * Represents a type of document with methods to check whether it is an instance
+ * of the type and to validate it.
+ * 
+ * @author Erik Brakkee
+ * 
+ */
 public interface DocumentType {
-    
+
     /**
-     * Symbolic name for the document type. 
-     * @return Name. 
+     * Symbolic name for the document type.
+     * 
+     * @return Name.
      */
     String getName();
 
     /**
-     * Checks if a document is of the given type. 
-     * @param aSource Document
-     * @return True iff the document is of the given type. 
+     * Checks if a document is of the given type.
+     * 
+     * @param aSource
+     *            Document
+     * @return True iff the document is of the given type.
      */
     boolean isInstance(DOMSource aSource);
-    
+
     /**
-     * Validates the document. Implementations that do not validate should simply
-     * return true always. 
-     * @param aSource Document.
-     * @return True iff the document is valid. 
+     * Validates the document. Implementations that do not validate should
+     * simply return true always.
+     * 
+     * @param aSource
+     *            Document.
+     * @return True iff the document is valid.
      */
     boolean validate(DOMSource aSource);
 }