package textbender.g.xml.sax.ext; // Copyright 2006, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Textbender Software"), to deal in the Textbender Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Textbender Software, and to permit persons to whom the Textbender Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Textbender Software. THE TEXTBENDER SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TEXTBENDER SOFTWARE OR THE USE OR OTHER DEALINGS IN THE TEXTBENDER SOFTWARE.

import org.xml.sax.*;
import org.xml.sax.ext.LexicalHandler;
import textbender.g.xml.sax.SAXEvent;


/** Persistent capture of a SAX comment() event.
  *
  *     @see org.xml.sax.ext.LexicalHandler#comment
  */
public class CommentEvent implements SAXEvent
{


    /** The common instance of an empty CommentEvent.
      */
    public static CommentEvent i0() { return instance0; }



    /** Constructs a CommentEvent.
      */
    public CommentEvent( char[] ch, int start, int length )
    {
//      this.ch = (char[])ch.clone();
        this.ch = ch.clone(); // store a copy, SAX event parameters are not persistable
        this.start = start;
        this.length = length;
    }



    /** Constructs a CommentEvent or, if length is zero or less, returns i0().
      */
    public static CommentEvent createOrReturn( char[] ch, int start, int length )
    {
        if( length <= 0 ) return instance0;
        else return new CommentEvent( ch, start, length );
    }



   // ------------------------------------------------------------------------------------


    public char[] ch() { return ch; }


        private final char[] ch;



    public int start() { return start; }


        private final int start;



    public int length() { return length; }


        private final int length;



   // - S A X - E v e n t ----------------------------------------------------------------


    public void send( ContentHandler handler ) throws SAXException
    {
        ((LexicalHandler)handler).comment( ch, start, length );
    }



//////////////////////////////////////////////////////////////////////////////////////////
// Last, so static fields above initialize, and are available during instantiation below


    private static final CommentEvent instance0
        = new CommentEvent( new char[] {}, /*start*/0, /*length*/0 );



}