com.jcabi.s3.cached

Class CdOcket

java.lang.Object

com.jcabi.s3.cached.CdOcket

All Implemented Interfaces:

Ocket, Comparable<Ocket>

@Immutable
@Loggable(value=1)
public final class CdOcket
extends Object
implements Ocket

Cached ocket.

Since:

0.8

Version:

$Id: c7772424ba1e7189c5fee34c2e3ec853adda7159 $

Author:

Yegor Bugayenko (yegor256@gmail.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.jcabi.s3.Ocket

Ocket.Empty, Ocket.Text

Constructor Summary

Constructors

Constructor and Description
CdOcket(Ocket okt) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
Bucket	bucket() Get bucket we're in.
int	compareTo(Ocket ocket)
boolean	exists() Check whether this S3 object exists.
String	key() Get object key.
com.amazonaws.services.s3.model.ObjectMetadata	meta() Object metadata.
void	read(OutputStream output) Read content.
String	toString()
void	write(InputStream input, com.amazonaws.services.s3.model.ObjectMetadata meta) Write new content to the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CdOcket

public CdOcket(Ocket okt)

Public ctor.

Parameters:

okt - Ocket original

Method Detail

toString

public String toString()

Overrides:

toString in class Object

bucket

public Bucket bucket()

Description copied from interface: Ocket

Get bucket we're in.

Specified by:

bucket in interface Ocket

Returns:

Bucket

key

public String key()

Description copied from interface: Ocket

Get object key.

Specified by:

key in interface Ocket

Returns:

Key

meta

@Cacheable
public com.amazonaws.services.s3.model.ObjectMetadata meta()
                                                    throws IOException

Description copied from interface: Ocket

Object metadata.

Throws OcketNotFoundException if this object doesn't exist in S3 bucket.

Specified by:

meta in interface Ocket

Returns:

Metadata

Throws:

IOException - If fails

exists

@Cacheable
public boolean exists()
               throws IOException

Description copied from interface: Ocket

Check whether this S3 object exists.

Specified by:

exists in interface Ocket

Returns:

TRUE if it exists in S3, FALSE otherwise

Throws:

IOException - If fails

read

public void read(OutputStream output)
          throws IOException

Description copied from interface: Ocket

Read content.

Throws OcketNotFoundException if this object doesn't exist in S3 bucket.

Specified by:

read in interface Ocket

Parameters:

output - Where to write

Throws:

IOException - If fails

write

@Cacheable.FlushAfter
public void write(InputStream input,
                              com.amazonaws.services.s3.model.ObjectMetadata meta)
           throws IOException

Description copied from interface: Ocket

Write new content to the object.

Specified by:

write in interface Ocket

Parameters:

input - Where to get content

meta - Metadata to save. Should contains input length for large object, otherwise multi-part uploads won't be possible.

Throws:

IOException - If fails

compareTo

public int compareTo(Ocket ocket)

Specified by:

compareTo in interface Comparable<Ocket>