com.comphenix.protocol.wrappers

Class WrappedServerPing.CompressedImage

java.lang.Object

com.comphenix.protocol.wrappers.WrappedServerPing.CompressedImage

Enclosing class:

WrappedServerPing

public static class WrappedServerPing.CompressedImage
extends java.lang.Object

Represents a compressed favicon.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	data
protected java.lang.String	encoded
protected java.lang.String	mime

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappedServerPing.CompressedImage() Represents a compressed image with no content.
	WrappedServerPing.CompressedImage(java.lang.String mime, byte[] data) Construct a new compressed image.

Method Summary

Methods

Modifier and Type	Method and Description
static WrappedServerPing.CompressedImage	fromBase64Png(java.lang.String base64) Retrieve a compressed image from a base-64 encoded PNG file.
static WrappedServerPing.CompressedImage	fromEncodedText(java.lang.String text) Retrieve a compressed image from an encoded text.
static WrappedServerPing.CompressedImage	fromPng(byte[] data) Retrieve a compressed image from a byte array of a PNG file.
static WrappedServerPing.CompressedImage	fromPng(java.io.InputStream input) Retrieve a compressed image from an input stream.
static WrappedServerPing.CompressedImage	fromPng(java.awt.image.RenderedImage image) Retrieve a compressed image from an image.
protected byte[]	getData() Retrieve the underlying data, with no copying.
byte[]	getDataCopy() Retrieve a copy of the underlying data array.
java.awt.image.BufferedImage	getImage() Uncompress and return the stored image.
java.lang.String	getMime() Retrieve the MIME type of the image.
java.lang.String	toEncodedText() Convert the compressed image to encoded text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mime

protected volatile java.lang.String mime

data

protected volatile byte[] data

encoded

protected volatile java.lang.String encoded

Constructor Detail

WrappedServerPing.CompressedImage

protected WrappedServerPing.CompressedImage()

Represents a compressed image with no content.

WrappedServerPing.CompressedImage

public WrappedServerPing.CompressedImage(java.lang.String mime,
                                 byte[] data)

Construct a new compressed image.

Parameters:

mime - - the mime type.

data - - the raw compressed image data.

Method Detail

fromPng

public static WrappedServerPing.CompressedImage fromPng(java.io.InputStream input)
                                                 throws java.io.IOException

Retrieve a compressed image from an input stream.

Parameters:

input - - the PNG as an input stream.

Returns:

The compressed image.

Throws:

java.io.IOException - If we cannot read the input stream.

fromPng

public static WrappedServerPing.CompressedImage fromPng(byte[] data)

Retrieve a compressed image from a byte array of a PNG file.

Parameters:

data - - the file as a byte array.

Returns:

The compressed image.

fromBase64Png

public static WrappedServerPing.CompressedImage fromBase64Png(java.lang.String base64)

Retrieve a compressed image from a base-64 encoded PNG file.

Parameters:

base64 - - the base 64-encoded PNG.

Returns:

The compressed image.

fromPng

public static WrappedServerPing.CompressedImage fromPng(java.awt.image.RenderedImage image)
                                                 throws java.io.IOException

Retrieve a compressed image from an image.

Parameters:

image - - the image.

Throws:

java.io.IOException - If we were unable to compress the image.

fromEncodedText

public static WrappedServerPing.CompressedImage fromEncodedText(java.lang.String text)

Retrieve a compressed image from an encoded text.

Parameters:

text - - the encoded text.

Returns:

The corresponding compressed image.

getMime

public java.lang.String getMime()

Retrieve the MIME type of the image.

This is image/png in vanilla Minecraft.

Returns:

The MIME type.

getDataCopy

public byte[] getDataCopy()

Retrieve a copy of the underlying data array.

Returns:

The underlying compressed image.

getData

protected byte[] getData()

Retrieve the underlying data, with no copying.

Returns:

The underlying data.

getImage

public java.awt.image.BufferedImage getImage()
                                      throws java.io.IOException

Uncompress and return the stored image.

Returns:

The image.

Throws:

java.io.IOException - If the image data could not be decoded.

toEncodedText

public java.lang.String toEncodedText()

Convert the compressed image to encoded text.

Returns:

The encoded text.