com.jcabi.s3.fake

Class FkOcket

java.lang.Object

com.jcabi.s3.fake.FkOcket

All Implemented Interfaces:

Ocket, Comparable<Ocket>

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

Mock/fake ocket.

Since:

0.6

Version:

$Id: c18b151dfeb44aff0b823cbfe54b70f66e468dba $

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
FkOcket() Ctor.
FkOcket(File file, String bucket, String key) Ctor.
FkOcket(Path file, String bucket, String key) Ctor.
FkOcket(String bucket, String key) Ctor.
FkOcket(String file, String bucket, String key) 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.
File	file() Get my file.
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

FkOcket

public FkOcket()
        throws IOException

Ctor.

Throws:

IOException - If fails

Since:

0.17

FkOcket

public FkOcket(String bucket,
       String key)
        throws IOException

Ctor.

Parameters:

bucket - Bucket

key - Key

Throws:

IOException - If fails

Since:

0.17

FkOcket

public FkOcket(Path file,
       String bucket,
       String key)

Ctor.

Parameters:

file - Dir we're in

bucket - Bucket

key - Key

Since:

0.17

FkOcket

public FkOcket(File file,
       String bucket,
       String key)

Ctor.

Parameters:

file - Dir we're in

bucket - Bucket

key - Key

FkOcket

public FkOcket(String file,
       String bucket,
       String key)

Ctor.

Parameters:

file - Dir we're in

bucket - Bucket

key - Key

Since:

0.17

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

public com.amazonaws.services.s3.model.ObjectMetadata meta()

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

exists

public boolean exists()

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

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

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>

file

public File file()

Get my file.

Returns:

File