Top Fields Constructors Methods
org.apache.sshd.common.compression

public Class CompressionNone

extends BaseCompression
Class Inheritance
Imports
java.io.IOException, .StreamCorruptedException, org.apache.sshd.common.util.buffer.Buffer

Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private int
private Compression.Type

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
compress(Buffer
the buffer containing the data to compress
buffer
)

Implements org.apache.sshd.common.compression.Compression.compress.

Compress the given buffer in place.

public void
init(Compression.Type
compression type
type
,
int
compression level
level
)

Implements org.apache.sshd.common.compression.Compression.init.

Initialize this object to either compress or uncompress data.

public boolean
public boolean
isDelayed()

Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.

public String
toString()

Overrides org.apache.sshd.common.compression.BaseCompression.toString.

Returns a string representation of the object.

public void
uncompress(Buffer
the buffer containing the data to uncompress
from
,
Buffer
the buffer receiving the uncompressed data
to
)

Implements org.apache.sshd.common.compression.Compression.uncompress.

Uncompress the data in a buffer into another buffer.

Inherited from org.apache.sshd.common.compression.BaseCompression:
getName

Field Detail

levelback to summary
private int level
typeback to summary
private Compression.Type type

Constructor Detail

CompressionNoneback to summary
public CompressionNone()

Method Detail

compressback to summary
public void compress(Buffer buffer) throws IOException

Implements org.apache.sshd.common.compression.Compression.compress.

Doc from org.apache.sshd.common.compression.Compression.compress.

Compress the given buffer in place.

Parameters
buffer:Buffer

the buffer containing the data to compress

Annotations
@Override
Exceptions
IOException:
if an error occurs
initback to summary
public void init(Compression.Type type, int level)

Implements org.apache.sshd.common.compression.Compression.init.

Doc from org.apache.sshd.common.compression.Compression.init.

Initialize this object to either compress or uncompress data. This method must be called prior to any calls to either compress or uncompress. Once the object has been initialized, only one of compress or uncompress methods can be called.

Parameters
type:Compression.Type

compression type

level:int

compression level

Annotations
@Override
isCompressionExecutedback to summary
public boolean isCompressionExecuted()

Overrides org.apache.sshd.common.compression.BaseCompression.isCompressionExecuted.

Implements org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

Returns:boolean

Doc from org.apache.sshd.common.compression.CompressionInformation.isCompressionExecuted.

true if there is any compression executed by this "compressor" - special case for 'none'

Annotations
@Override
isDelayedback to summary
public boolean isDelayed()

Implements org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Doc from org.apache.sshd.common.compression.CompressionInformation.isDelayed.

Delayed compression is an Open-SSH specific feature which informs both the client and server to not compress data before the session has been authenticated.

Returns:boolean

if the compression is delayed after authentication or not

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.apache.sshd.common.compression.BaseCompression.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
uncompressback to summary
public void uncompress(Buffer from, Buffer to) throws IOException

Implements org.apache.sshd.common.compression.Compression.uncompress.

Doc from org.apache.sshd.common.compression.Compression.uncompress.

Uncompress the data in a buffer into another buffer.

Parameters
from:Buffer

the buffer containing the data to uncompress

to:Buffer

the buffer receiving the uncompressed data

Annotations
@Override
Exceptions
IOException:
if an error occurs