aQute.bnd.service.url

Class TaggedData

java.lang.Object

aQute.bnd.service.url.TaggedData

All Implemented Interfaces:

Closeable, AutoCloseable

public class TaggedData
extends Object
implements Closeable

Represents a data stream that has a tag associated with it; the primary use-case is an HTTP response stream with an ETag header.

Author:

Neil Bartlett

Constructor Summary

Constructors

Constructor and Description
TaggedData(String tag, InputStream inputStream) Deprecated.
TaggedData(String tag, InputStream inputStream, int responseCode) Deprecated.
TaggedData(String tag, InputStream inputStream, int responseCode, long modified, URI url) Deprecated.
TaggedData(URI url, int responseCode, File file)
TaggedData(URLConnection con, InputStream in)
TaggedData(URLConnection con, InputStream in, File file)

Method Summary

Modifier and Type	Method and Description
void	close()
URLConnection	getConnection()
File	getFile()
InputStream	getInputStream() Returns the input stream containing the resource data.
long	getModified()
int	getResponseCode()
State	getState()
String	getTag() Returns the ETag for the retrieved resource, or null if the ETag was not provided by the server.
URI	getUrl()
boolean	hasPayload()
boolean	isNotFound()
boolean	isNotModified()
boolean	isOk()
void	throwIt()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TaggedData

@Deprecated
public TaggedData(String tag,
                              InputStream inputStream,
                              int responseCode,
                              long modified,
                              URI url)

Deprecated.

TaggedData

@Deprecated
public TaggedData(String tag,
                              InputStream inputStream,
                              int responseCode)

Deprecated.

TaggedData

@Deprecated
public TaggedData(String tag,
                              InputStream inputStream)

Deprecated.

TaggedData

public TaggedData(URLConnection con,
                  InputStream in)
           throws Exception

Throws:

Exception

TaggedData

public TaggedData(URLConnection con,
                  InputStream in,
                  File file)
           throws Exception

Throws:

Exception

TaggedData

public TaggedData(URI url,
                  int responseCode,
                  File file)
           throws Exception

Throws:

Exception

Method Detail

getTag

public String getTag()

Returns the ETag for the retrieved resource, or null if the ETag was not provided by the server.

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns the input stream containing the resource data.

Throws:

IOException

getResponseCode

public int getResponseCode()

getModified

public long getModified()

hasPayload

public boolean hasPayload()
                   throws IOException

Throws:

IOException

getUrl

public URI getUrl()

getConnection

public URLConnection getConnection()

toString

public String toString()

Overrides:

toString in class Object

isOk

public boolean isOk()

isNotModified

public boolean isNotModified()

throwIt

public void throwIt()

getState

public State getState()

isNotFound

public boolean isNotFound()

getFile

public File getFile()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException