1 /*
   2  * Copyright (c) 2005, 2010, Thai Open Source Software Center Ltd
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  *
  12  *     Redistributions in binary form must reproduce the above copyright
  13  *     notice, this list of conditions and the following disclaimer in
  14  *     the documentation and/or other materials provided with the
  15  *     distribution.
  16  *
  17  *     Neither the name of the Thai Open Source Software Center Ltd nor
  18  *     the names of its contributors may be used to endorse or promote
  19  *     products derived from this software without specific prior written
  20  *     permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
  26  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  27  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  28  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  29  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  30  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  31  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34 
  35 package org.relaxng.datatype;
  36 
  37 /**
  38  * Creates a user-defined type by adding parameters to
  39  * the pre-defined type.
  40  *
  41  * @author <a href="mailto:jjc@jclark.com">James Clark</a>
  42  * @author <a href="mailto:kohsuke.kawaguchi@sun.com">Kohsuke KAWAGUCHI</a>
  43  */
  44 public interface DatatypeBuilder {
  45 
  46         /**
  47          * Adds a new parameter.
  48          *
  49          * @param name
  50          *              The name of the parameter to be added.
  51          * @param strValue
  52          *              The raw value of the parameter. Caller may not normalize
  53          *              this value because any white space is potentially significant.
  54          * @param context
  55          *              The context information which can be used by the callee to
  56          *              acquire additional information. This context object is
  57          *              valid only during this method call. The callee may not
  58          *              keep a reference to this object.
  59          * @exception   DatatypeException
  60          *              When the given parameter is inappropriate for some reason.
  61          *              The callee is responsible to recover from this error.
  62          *              That is, the object should behave as if no such error
  63          *              was occured.
  64          */
  65         void addParameter( String name, String strValue, ValidationContext context )
  66                 throws DatatypeException;
  67 
  68         /**
  69          * Derives a new Datatype from a Datatype by parameters that
  70          * were already set through the addParameter method.
  71          *
  72          * @exception DatatypeException
  73          *              DatatypeException must be thrown if the derivation is
  74          *              somehow invalid. For example, a required parameter is missing,
  75          *              etc. The exception should contain a diagnosis message
  76          *              if possible.
  77          */
  78         Datatype createDatatype() throws DatatypeException;
  79 }