content: /*
   *  This file is part of AndroidIDE.
   *
   *  AndroidIDE is free software: you can redistribute it and/or modify
   *  it under the terms of the GNU General Public License as published by
   *  the Free Software Foundation, either version 3 of the License, or
   *  (at your option) any later version.
   *
   *  AndroidIDE is distributed in the hope that it will be useful,
   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   *  GNU General Public License for more details.
   *
   *  You should have received a copy of the GNU General Public License
   *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
   */
  
  /*
   * reserved comment block
   * DO NOT REMOVE OR ALTER!
   */
  /*
   * The Apache Software License, Version 1.1
   *
   *
   * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Xerces" and "Apache Software Foundation" must
   *    not be used to endorse or promote products derived from this
   *    software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    nor may "Apache" appear in their name, without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation and was
   * originally based on software copyright (c) 1999, International
   * Business Machines, Inc., http://www.apache.org.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package jaxp.sun.org.apache.xerces.internal.impl.dtd.models;
  
  /**
   * A content model node.
   *
   * @xerces.internal
   *
   */
  public abstract class CMNode
  {
      // -------------------------------------------------------------------
      //  Constructors
      // -------------------------------------------------------------------
      public CMNode(int type)
      {
          fType = type;
      }
  
  
      // -------------------------------------------------------------------
      //  Package, abstract methods
      // -------------------------------------------------------------------
      // made this public so it could be implemented and used outside this package -neilg.
      public abstract boolean isNullable() ;
  
  
      // -------------------------------------------------------------------
      //  Package final methods
      // -------------------------------------------------------------------
      public final int type()
      {
          return fType;
      }
  
      // made this public so it could be implemented and used outside this package -neilg.
      public final CMStateSet firstPos()
      {
          if (fFirstPos == null)
          {
              fFirstPos = new CMStateSet(fMaxStates);
              calcFirstPos(fFirstPos);
          }
          return fFirstPos;
      }
  
      // made this public so it could be implemented and used outside this package -neilg.
      public final CMStateSet lastPos()
      {
          if (fLastPos == null)
          {
              fLastPos = new CMStateSet(fMaxStates);
              calcLastPos(fLastPos);
          }
          return fLastPos;
      }
  
      final void setFollowPos(CMStateSet setToAdopt)
      {
          fFollowPos = setToAdopt;
      }
  
      public final void setMaxStates(int maxStates)
      {
          fMaxStates = maxStates;
      }
  
      /**
       * Allows the user to set arbitrary data on this content model
       * node. This is used by the a{n,m} optimization that runs
       * in constant space.
       */
      public void setUserData(Object userData) {
          fUserData = userData;
      }
  
      /**
       * Allows the user to get arbitrary data set on this content
       * model node. This is used by the a{n,m} optimization that runs
       * in constant space.
       */
      public Object getUserData() {
          return fUserData;
      }
  
      // -------------------------------------------------------------------
      //  Protected, abstract methods
      // -------------------------------------------------------------------
      protected abstract void calcFirstPos(CMStateSet toSet) ;
  
      protected abstract void calcLastPos(CMStateSet toSet) ;
  
  
      // -------------------------------------------------------------------
      //  Private data members
      //
      //  fType
      //      The type of node. This indicates whether its a leaf or an
      //      operation. Though we also do derived classes for these types,
      //      it is too expensive to use runtime typing to find this out.
      //      This is one of the ContentSpecNode.NODE_XXX types.
      //
      //  fFirstPos
      //      The set of NFA states that represent the entry states of this
      //      node in the DFA.
      //
      //  fFollowPos
      //      The set of NFA states that can be gotten to from from this
      //      node in the DFA.
      //
      //  fLastPos
      //      The set of NFA states that represent the final states of this
      //      node in the DFA.
      //
      //  fMaxStates
      //      The maximum number of states that the NFA has, which means the
      //      max number of NFA states that have to be traced in the state
      //      sets during the building of the DFA. Its unfortunate that it
      //      has to be stored redundantly, but we need to fault in the
      //      state set members and they have to be sized to this size. We
      //      init to to -1 so it will cause an error if its used without
      //      being initialized.
      // -------------------------------------------------------------------
      private int         fType;
      private CMStateSet  fFirstPos   = null;
      private CMStateSet  fFollowPos  = null;
      private CMStateSet  fLastPos    = null;
      private int         fMaxStates  = -1;
      private Object      fUserData   = null;
  };
  