1 /*
   2  * Copyright (c) 2005, 2012, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.stream.buffer;
  27 
  28 import java.util.Map;
  29 
  30 /**
  31  * A mark into a buffer.
  32  *
  33  * <p>
  34  * A mark can be processed in the same manner as a XMLStreamBuffer.
  35  *
  36  * <p>
  37  * A mark will share a sub set of information of the buffer that is
  38  * marked. If the buffer is directly or indirectly associated with a
  39  * (mutable) {@link XMLStreamBuffer} which is reset and/or re-created
  40  * then this will invalidate the mark and processing behvaiour of the mark
  41  * is undefined. It is the responsibility of the application to manage the
  42  * relationship between the marked XMLStreamBuffer and one or more marks.
  43  */
  44 public class XMLStreamBufferMark extends XMLStreamBuffer {
  45 
  46     /**
  47      * Create a mark from the buffer that is being created.
  48      *
  49      * <p>
  50      * A mark will be created from the current position of creation of the
  51      * {@link XMLStreamBuffer} that is being created by a {@link AbstractCreator}.
  52      *
  53      * @param inscopeNamespaces
  54      * The in-scope namespaces on the fragment of XML infoset that is
  55      * to be marked.
  56      *
  57      * @param src
  58      * The {@link AbstractCreator} or {@link AbstractProcessor} from which the current
  59      * position of creation of the XMLStreamBuffer will be taken as the mark.
  60      */
  61     public XMLStreamBufferMark(Map<String,String> inscopeNamespaces, AbstractCreatorProcessor src) {
  62         if(inscopeNamespaces != null) {
  63             _inscopeNamespaces = inscopeNamespaces;
  64         }
  65 
  66         _structure = src._currentStructureFragment;
  67         _structurePtr = src._structurePtr;
  68 
  69         _structureStrings = src._currentStructureStringFragment;
  70         _structureStringsPtr = src._structureStringsPtr;
  71 
  72         _contentCharactersBuffer = src._currentContentCharactersBufferFragment;
  73         _contentCharactersBufferPtr = src._contentCharactersBufferPtr;
  74 
  75         _contentObjects = src._currentContentObjectFragment;
  76         _contentObjectsPtr = src._contentObjectsPtr;
  77         treeCount = 1; // TODO: define a way to create a mark over a forest
  78     }
  79 }