BinaryDataReaderQueueService.java

/* 
 * Licensed under the Apache License, Version 2.0 (the "License");
 *
 * You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 *
 * Contributions from 2013-2017 where performed either by US government 
 * employees, or under US Veterans Health Administration contracts. 
 *
 * US Veterans Health Administration contributions by government employees
 * are work of the U.S. Government and are not subject to copyright
 * protection in the United States. Portions contributed by government 
 * employees are USGovWork (17USC §105). Not subject to copyright. 
 * 
 * Contribution by contractors to the US Veterans Health Administration
 * during this period are contractually contributed under the
 * Apache License, Version 2.0.
 *
 * See: https://www.usa.gov/government-works
 * 
 * Contributions prior to 2013:
 *
 * Copyright (C) International Health Terminology Standards Development Organisation.
 * Licensed under the Apache License, Version 2.0.
 *
 */



package sh.isaac.api.externalizable;

//~--- JDK imports ------------------------------------------------------------

import java.util.concurrent.BlockingQueue;

//~--- interfaces -------------------------------------------------------------

/**
 * {@link BinaryDataReaderQueueService}.
 *
 * @author <a href="mailto:daniel.armbrust.list@gmail.com">Dan Armbrust</a>
 */
public interface BinaryDataReaderQueueService {
   /**
    * Cancel any inprogress processing.
    */
   public void shutdown();

   //~--- get methods ---------------------------------------------------------

   /**
    * Call to determine if no futher elements will populate the queue.
    *
    * @return true, if finished
    */
   public boolean isFinished();

   /**
    * Return a queue view of the data reader service - the queue being populated by a multi-threaded operation.
    * Order is not maintained.
    *
    * @return the queue
    */
   BlockingQueue<OchreExternalizable> getQueue();
}