• Home
• javax.net.websocket
• javax.net.websocket-api
• 1.0-b04
• source code
• Encoder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

javax.net.websocket.Encoder Maven / Gradle / Ivy

/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package javax.net.websocket;

import java.util.Iterator;

/**
 * The Encoder interfaces defines how developers can provide a way to convert
 * their custom objects into web socket messages.
 * @author dannycoward
 * @since DRAFT 002
 */
public interface Encoder {
    /** This interface defines how to provide a way to convert a custom
     * object into a text message.
     * @param  
     */
    public interface Text extends Encoder {
        /** Encode the given object into a String. */
        public String encode(T object) throws EncodeException;
    }
    /** This interface defines how to provide a way to convert a custom
     * object into a binary message.
     * @param  
     */
    public interface Binary extends Encoder {
        /** Encode the given object into a byte array. */
        public byte[] encode(T object) throws EncodeException;

    }
}