wamblee.org Git - xmlrouter/blob - 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 /**
  21  * Represents a type of document with methods to check whether it is an instance
  22  * of the type and to validate it.
  23  *
  24  * @author Erik Brakkee
  25  *
  26  */
  27 public interface DocumentType {
  28
  29     /**
  30      * Symbolic name for the document type.
  31      *
  32      * @return Name.
  33      */
  34     String getName();
  35
  36     /**
  37      * Checks if a document is of the given type.
  38      *
  39      * @param aSource
  40      *            Document
  41      * @return True iff the document is of the given type.
  42      */
  43     boolean isInstance(DOMSource aSource);
  44
  45     /**
  46      * Validates the document. Implementations that do not validate should
  47      * simply return true always.
  48      *
  49      * @param aSource
  50      *            Document.
  51      * @return True iff the document is valid.
  52      */
  53     boolean validate(DOMSource aSource);
  54 }