Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
private final URLConnection	con
private static final Pattern	ENTITIES_P
private final String	etag
private final File	file
private static final Pattern	HTML_TAGS_P
private final InputStream	in
private final String	message
private static final Pattern	NEWLINES_P
private final int	responseCode
private final URI	url

Constructor Summary

Constructors

Constructor	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	Description
private String	cleanHtml(CharSequence sb)
void	close()
private String	entity(String name)
URLConnection	getConnection()
File	getFile()
InputStream	getInputStream()	Returns the input stream containing the resource data.
private String	getMessage(URLConnection con)
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

Field Details

con

private final URLConnection con

responseCode

private final int responseCode

etag

private final String etag

in

private final InputStream in

url

private final URI url

file

private final File file

message

private final String message

HTML_TAGS_P

private static final Pattern HTML_TAGS_P

NEWLINES_P

private static final Pattern NEWLINES_P

ENTITIES_P

private static final Pattern ENTITIES_P

Constructor Details

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 Details

getMessage

private String getMessage(URLConnection con)

cleanHtml

private String cleanHtml(CharSequence sb)

entity

private String entity(String name)

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 AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException