core/src/main/java/flex/messaging/messages/SmallMessage.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

package flex.messaging.messages;

/**
 * A marker interface that is used to indicate that a Message has an
 * alternative smaller form for serialization.
 */
public interface SmallMessage extends Message {
    /**
     * This method must be implemented by subclasses that have an
     * <code>java.io.Externalizable</code> or "small" form, or null to
     * indicate that a small form is not available.
     *
     * @return An alternative representation of a
     * flex.messaging.messages.Message so that the size of the serialized
     * message is smaller.
     */
    Message getSmallMessage();
}