1   /*
    2    * Copyright 2005 Sun Microsystems, Inc.  All Rights Reserved.
    3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
    4    *
    5    * This code is free software; you can redistribute it and/or modify it
    6    * under the terms of the GNU General Public License version 2 only, as
    7    * published by the Free Software Foundation.  Sun designates this
    8    * particular file as subject to the "Classpath" exception as provided
    9    * by Sun in the LICENSE file that accompanied this code.
   10    *
   11    * This code is distributed in the hope that it will be useful, but WITHOUT
   12    * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   13    * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   14    * version 2 for more details (a copy is included in the LICENSE file that
   15    * accompanied this code).
   16    *
   17    * You should have received a copy of the GNU General Public License version
   18    * 2 along with this work; if not, write to the Free Software Foundation,
   19    * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   20    *
   21    * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
   22    * CA 95054 USA or visit www.sun.com if you need additional information or
   23    * have any questions.
   24    */
   25   package org.relaxng.datatype;
   26   
   27   /**
   28    * Datatype streaming validator.
   29    *
   30    * <p>
   31    * The streaming validator is an optional feature that is useful for
   32    * certain Datatypes. It allows the caller to incrementally provide
   33    * the literal.
   34    *
   35    * @author <a href="mailto:jjc@jclark.com">James Clark</a>
   36    * @author <a href="mailto:kohsuke.kawaguchi@sun.com">Kohsuke KAWAGUCHI</a>
   37    */
   38   public interface DatatypeStreamingValidator {
   39   
   40           /**
   41            * Passes an additional fragment of the literal.
   42            *
   43            * <p>
   44            * The application can call this method several times, then call
   45            * the isValid method (or the checkValid method) to check the validity
   46            * of the accumulated characters.
   47            */
   48           void addCharacters( char[] buf, int start, int len );
   49   
   50           /**
   51            * Tells if the accumulated literal is valid with respect to
   52            * the underlying Datatype.
   53            *
   54            * @return
   55            *              True if it is valid. False if otherwise.
   56            */
   57           boolean isValid();
   58   
   59           /**
   60            * Similar to the isValid method, but this method throws
   61            * Exception (with possibly diagnostic information), instead of
   62            * returning false.
   63            *
   64            * @exception DatatypeException
   65            *              If the callee supports the diagnosis and the accumulated
   66            *              literal is invalid, then this exception that possibly
   67            *              contains diagnosis information is thrown.
   68            */
   69           void checkValid() throws DatatypeException;
   70   }