org.eclipse.jetty.websocket.jsr356.metadata.CoderMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax-websocket-client-impl Show documentation
The newest version!
//
//  ========================================================================
//  Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.websocket.jsr356.metadata;

import org.eclipse.jetty.websocket.jsr356.MessageType;

/**
 * The immutable base metadata for a coder ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder}
 *
 * @param  the specific type of coder ({@link javax.websocket.Decoder} or {@link javax.websocket.Encoder}
 */
public abstract class CoderMetadata
{
    /**
     * The class for the Coder
     */
    private final Class coderClass;
    /**
     * The Class that the Decoder declares it decodes
     */
    private final Class objType;
    /**
     * The Basic type of message the decoder handles
     */
    private final MessageType messageType;
    /**
     * Flag indicating if Decoder is for streaming (or not)
     */
    private final boolean streamed;

    public CoderMetadata(Class coderClass, Class objType, MessageType messageType, boolean streamed)
    {
        this.objType = objType;
        this.coderClass = coderClass;
        this.messageType = messageType;
        this.streamed = streamed;
    }

    public Class getCoderClass()
    {
        return this.coderClass;
    }

    public MessageType getMessageType()
    {
        return messageType;
    }

    public Class getObjectType()
    {
        return objType;
    }

    public boolean isStreamed()
    {
        return streamed;
    }
}