org.eclipse.jetty.websocket.jsr356.metadata.MessageHandlerMetadata Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2015 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// 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 javax.websocket.MessageHandler;
/**
* An immutable metadata for a {@link MessageHandler}, representing a single interface on a message handling class.
*
* A message handling class can contain more than 1 valid {@link MessageHandler} interface, this will result in multiple {@link MessageHandlerMetadata}
* instances, each tracking one of the {@link MessageHandler} interfaces declared.
*/
public class MessageHandlerMetadata
{
/**
* The implemented MessageHandler class.
*
* Commonly a end-user provided class, with 1 or more implemented {@link MessageHandler} interfaces
*/
private final Class handlerClass;
/**
* Indicator if this is a {@link MessageHandler.Partial} or {@link MessageHandler.Whole} interface.
*
* True for MessageHandler.Partial, other wise its a MessageHandler.Whole
*/
private final boolean isPartialSupported;
/**
* The class type that this specific interface's generic implements.
*
* Or said another way, the first parameter type on this interface's onMessage() method.
*/
private final Class messageClass;
public MessageHandlerMetadata(Class handlerClass, Class messageClass, boolean partial)
{
this.handlerClass = handlerClass;
this.isPartialSupported = partial;
this.messageClass = messageClass;
}
public Class getHandlerClass()
{
return handlerClass;
}
public Class getMessageClass()
{
return messageClass;
}
public boolean isPartialSupported()
{
return isPartialSupported;
}
}