org.refcodes.codec.BaseEncoder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-codec Show documentation
Show all versions of refcodes-codec Show documentation
Artifact with encoding and decoding (not in terms of encryption/decryption)
implementations (codecs) such as BASE64 encoding / decoding.
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////
package org.refcodes.codec;
import org.refcodes.codec.BaseMetricsAccessor.BaseCodecMetricsProperty;
import org.refcodes.codec.BaseMetricsAccessor.BaseMetricsBuilder;
import org.refcodes.component.ConnectionComponent;
import org.refcodes.io.ByteConsumer;
import org.refcodes.io.ByteSender;
/**
* The {@link BaseEncoder} implements the {@link BaseBuilder} functionality in
* terms of a {@link ByteSender}.It implements the {@link Encoder} interface
* attaching to the "refcodes-io" artifact via the {@link Encoder} interface.
* This increases the scope of usage scenarios.
*/
public interface BaseEncoder extends BaseCodecMetricsProperty, BaseMetricsBuilder, Encoder {
// /////////////////////////////////////////////////////////////////////////
// INNER CLASSES:
// /////////////////////////////////////////////////////////////////////////
/**
* The {@link BaseEncoderConsumer} implements the {@link BaseEncoder}
* functionality in terms of a {@link ConnectionComponent}. In addition to
* the {@link BaseEncoder} it provides means to open a dedicated
* {@link ByteConsumer} connection.
*/
public static interface BaseEncoderConsumer extends BaseEncoder, ConnectionComponent {}
}