freenet.client

Class ClientMetadata

java.lang.Object

freenet.client.ClientMetadata

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ClientMetadata
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Stores the metadata that the client might actually be interested in. Currently this is just the MIME type, but in future it might be more than that. Size is not stored here, but maybe things like dublin core or whatever. WARNING: Changing non-transient members on classes that are Serializable can result in restarting downloads or losing uploads.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientMetadata()
ClientMetadata(java.lang.String mime)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the MIME type.
ClientMetadata	clone()
static ClientMetadata	construct(java.io.DataInputStream dis) Factory method to keep the API cleaner, avoid ambiguity; this won't be used as often as the String constructor.
java.lang.String	getMIMEType() Get the document MIME type.
java.lang.String	getMIMETypeNoParams() Return the MIME type minus any type parameters (e.g.
boolean	isTrivial() Is there no MIME type?
void	mergeNoOverwrite(ClientMetadata clientMetadata) Merge the given ClientMetadata, without overwriting our existing information.
java.lang.String	toString()
void	writeTo(java.io.DataOutputStream dos)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientMetadata

public ClientMetadata()

ClientMetadata

public ClientMetadata(java.lang.String mime)

Method Detail

construct

public static ClientMetadata construct(java.io.DataInputStream dis)
                                throws MetadataParseException,
                                       java.io.IOException

Factory method to keep the API cleaner, avoid ambiguity; this won't be used as often as the String constructor.

Throws:

MetadataParseException

java.io.IOException

getMIMEType

public java.lang.String getMIMEType()

Get the document MIME type. Will always be a valid MIME type, unless there has been an error; if it is unknown, will return application/octet-stream.

mergeNoOverwrite

public void mergeNoOverwrite(ClientMetadata clientMetadata)

Merge the given ClientMetadata, without overwriting our existing information.

isTrivial

public boolean isTrivial()

Is there no MIME type?

clone

public ClientMetadata clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

public void clear()

Clear the MIME type.

getMIMETypeNoParams

public java.lang.String getMIMETypeNoParams()

Return the MIME type minus any type parameters (e.g. charset, see the RFCs defining the MIME type for details).

writeTo

public void writeTo(java.io.DataOutputStream dos)
             throws java.io.IOException

Throws:

java.io.IOException