added comment headers.
[xmlrouter] / config / src / main / java / org / wamblee / xmlrouter / config / DocumentType.java
1 /*
2  * Copyright 2005-2011 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16 package org.wamblee.xmlrouter.config;
17
18 import javax.xml.transform.dom.DOMSource;
19
20 public interface DocumentType {
21     
22     /**
23      * Symbolic name for the document type. 
24      * @return Name. 
25      */
26     String getName();
27
28     /**
29      * Checks if a document is of the given type. 
30      * @param aSource Document
31      * @return True iff the document is of the given type. 
32      */
33     boolean isInstance(DOMSource aSource);
34     
35     /**
36      * Validates the document. Implementations that do not validate should simply
37      * return true always. 
38      * @param aSource Document.
39      * @return True iff the document is valid. 
40      */
41     boolean validate(DOMSource aSource);
42 }