001/*
002 * (C) Copyright 2017 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bdelbosc
018 */
019package org.nuxeo.lib.stream.pattern;
020
021import java.io.Externalizable;
022
023/**
024 * A message is an {@link Externalizable} with an identifier.
025 */
026public interface Message extends Externalizable {
027
028    /**
029     * A message identifier.
030     */
031    String getId();
032
033    /**
034     * A consumer reading this message must not wait for new message to process the batch.
035     */
036    default boolean forceBatch() {
037        return false;
038    }
039
040    /**
041     * This message is a poison pill it contains no other data, a consumer reading this message will process the batch
042     * and stop.
043     */
044    default boolean poisonPill() {
045        return false;
046    }
047
048}