content: /*
   * Copyright 2007-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   *
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   *
   *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  
  package com.amazon.ion.impl;
  
  import com.amazon.ion.IonReader;
  import com.amazon.ion.SymbolTable;
  
  import java.io.IOException;
  
  /**
   * An {@link IonReader} {@linkplain com.amazon.ion.facet facet} that can rapidly bulk-copy
   * Ion binary data under certain circumstances.
   */
  public interface _Private_ByteTransferReader
  {
      /**
       * Copies the raw bytes representing the current value, excluding any field name or annotations, if possible.
       * @param writer the sink for the bytes
       * @return true if the byte transfer occurred; false if it was not possible.
       * @throws IOException if thrown by the sink during transfer.
       */
      public boolean transferCurrentValue(_Private_ByteTransferSink writer)
          throws IOException;
  
      /**
       * Determines whether the reader's symbol table is compatible (i.e., a subset of) the given symbol table. When
       * true, values can be transferred from the reader to the writer verbatim.
       * @param symbolTable the symbol table active in the writer.
       * @return true if the reader's symbol table is compatible; otherwise, false.
       */
      public boolean isSymbolTableCompatible(SymbolTable symbolTable);
  }
  