com.qcloud.cos.model

Class COSObject

java.lang.Object

com.qcloud.cos.model.COSObject

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public class COSObject
extends Object
implements Closeable, Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
COSObject()

Method Summary

Modifier and Type	Method and Description
void	close() Releases any underlying system resources.
String	getBucketName() Gets the name of the bucket in which this object is contained.
String	getKey() Gets the key under which this object is stored.
COSObjectInputStream	getObjectContent() Gets the input stream containing the contents of this object.
ObjectMetadata	getObjectMetadata() Gets the metadata stored by Qcloud COS for this object.
void	setBucketName(String bucketName) Sets the name of the bucket in which this object is contained.
void	setKey(String key) Sets the key under which this object is stored.
void	setObjectContent(COSObjectInputStream objectContent) Sets the input stream containing this object's contents.
void	setObjectContent(InputStream objectContent) Sets the input stream containing this object's contents.
void	setObjectMetadata(ObjectMetadata metadata) Sets the object metadata for this object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

COSObject

public COSObject()

Method Detail

getObjectMetadata

public ObjectMetadata getObjectMetadata()

Gets the metadata stored by Qcloud COS for this object. The ObjectMetadata object includes any custom user metadata supplied by the caller when the object was uploaded, as well as HTTP metadata such as content length and content type.

Returns:

The metadata stored by Qcloud COS for this object.

See Also:

getObjectContent()

setObjectMetadata

public void setObjectMetadata(ObjectMetadata metadata)

Sets the object metadata for this object.

NOTE: This does not update the object metadata stored in Qcloud COS, but only updates this object in local memory. To update an object's metadata in COS, use COS#copyObject(CopyObjectRequest) to copy the object to a new (or the same location) and specify new object metadata then.

Parameters:

metadata - The new metadata to set for this object in memory.

getObjectContent

public COSObjectInputStream getObjectContent()

Gets the input stream containing the contents of this object.

Note: The method is a simple getter and does not actually create a stream. If you retrieve an COSObject, you should close this input stream as soon as possible, because the object contents aren't buffered in memory and stream directly from Qcloud COS. Further, failure to close this stream can cause the request pool to become blocked.

Returns:

An input stream containing the contents of this object.

See Also:

getObjectMetadata(), setObjectContent(InputStream)

setObjectContent

public void setObjectContent(COSObjectInputStream objectContent)

Sets the input stream containing this object's contents.

Parameters:

objectContent - The input stream containing this object's contents.

See Also:

getObjectContent()

setObjectContent

public void setObjectContent(InputStream objectContent)

Sets the input stream containing this object's contents.

Parameters:

objectContent - The input stream containing this object's contents. Will get wrapped in an COSObjectInputStream.

See Also:

getObjectContent()

getBucketName

public String getBucketName()

Gets the name of the bucket in which this object is contained.

Returns:

The name of the bucket in which this object is contained.

See Also:

setBucketName(String)

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket in which this object is contained.

Parameters:

bucketName - The name of the bucket containing this object.

See Also:

getBucketName()

getKey

public String getKey()

Gets the key under which this object is stored.

Returns:

The key under which this object is stored.

See Also:

setKey(String)

setKey

public void setKey(String key)

Sets the key under which this object is stored.

Parameters:

key - The key under which this object is stored.

See Also:

getKey()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

close

public void close()
           throws IOException

Releases any underlying system resources. If the resources are already released then invoking this method has no effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs