com.netflix.msl.io.MslEncodable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of msl-core Show documentation

msl-core

There is a newer version: 1.2226.0

/**
 * Copyright (c) 2015-2017 Netflix, Inc.  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.
 * 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 com.netflix.msl.io;


/**
 * This interface allows a class to override the default behavior when being
 * encoded into a {@link MslObject} or {@link MslArray}.
 * 
 * @author Wesley Miaw 
 */
public interface MslEncodable {
    /**
     * Returns the requested encoding of a MSL object representing the
     * implementing class.
     * 
     * @param encoder the encoder factory.
     * @param format the encoder format.
     * @return a MSL encoding of the MSL object.
     * @throws MslEncoderException if the encoder format is not supported or
     *         there is an error encoding the data.
     */
    public byte[] toMslEncoding(final MslEncoderFactory encoder, final MslEncoderFormat format) throws MslEncoderException;
}