org.pfsw.net

Class NetUtil

java.lang.Object

org.pfsw.net.NetUtil

public class NetUtil
extends java.lang.Object

Utility and convenience methods for network programming, provided as singleton. The class has a protected default constructor that allows to extend it and potentially override methods.

Field Summary

Fields

Modifier and Type	Field and Description
static NetUtil	NU
protected static char	SLASH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetUtil()

Method Summary

Modifier and Type	Method and Description
java.net.URI	asURI(java.lang.String uriString) Returns the given string as URI if possible.
java.net.URL	asURL(java.lang.String urlString) Returns the given string as URL if possible.
boolean	close(java.io.Closeable closeable) Silently closes the given object.
static NetUtil	current() Returns the only instance this class supports (design pattern "Singleton")
protected StringUtil	str()
java.lang.String	urlDecode(java.lang.String string, java.nio.charset.Charset charset) Returns the given string character and URL decoded.
java.lang.String	urlEncode(java.lang.String string, java.nio.charset.Charset charset) Returns the given string character and URL encoded.
java.lang.String	withLeadingSlash(java.lang.String string) Returns the given string guaranteed with a leading slash.
java.lang.String	withoutLeadingSlash(java.lang.String string) Returns the given string guaranteed with no leading slash.
java.lang.String	withoutTrailingSlash(java.lang.String string) Returns the given string guaranteed with no trailing slash.
java.lang.String	withTrailingSlash(java.lang.String string) Returns the given string guaranteed with a trailing slash.

Methods inherited from class java.lang.Object

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

Field Detail

NU

public static final NetUtil NU

SLASH

protected static final char SLASH

See Also:

Constant Field Values

Constructor Detail

NetUtil

protected NetUtil()

Method Detail

current

public static NetUtil current()

Returns the only instance this class supports (design pattern "Singleton")

close

public boolean close(java.io.Closeable closeable)

Silently closes the given object. If the given object is null, nothing will be done. If an IOException occurs false will be returned.

Parameters:

closeable - The object to close (may be null).

Returns:

true if executed without problem, false if an IOException occurred.

urlEncode

public java.lang.String urlEncode(java.lang.String string,
                                  java.nio.charset.Charset charset)

Returns the given string character and URL encoded.

Parameters:

string - The string to be encoded (if null, null will be returned).

charset - The character encoding to be used on the string before doing the URL encoding (must not be null).

Returns:

The encoded string or null in case of a completely unexpected UnsupportedEncodingException.

urlDecode

public java.lang.String urlDecode(java.lang.String string,
                                  java.nio.charset.Charset charset)

Returns the given string character and URL decoded.

Parameters:

string - The string to be decoded (if null, null will be returned).

charset - The character encoding to be used on the string after the URL decoding (must not be null).

Returns:

The decoded string or null in case of a completely unexpected UnsupportedEncodingException.

withLeadingSlash

public java.lang.String withLeadingSlash(java.lang.String string)

Returns the given string guaranteed with a leading slash.

Parameters:

string - The string that should have a leading slash (must not be null).

withTrailingSlash

public java.lang.String withTrailingSlash(java.lang.String string)

Returns the given string guaranteed with a trailing slash.

Parameters:

string - The string that should have a trailing slash (must not be null).

withoutLeadingSlash

public java.lang.String withoutLeadingSlash(java.lang.String string)

Returns the given string guaranteed with no leading slash.

Parameters:

string - The string that should not have a leading slash (must not be null).

withoutTrailingSlash

public java.lang.String withoutTrailingSlash(java.lang.String string)

Returns the given string guaranteed with no trailing slash.

Parameters:

string - The string that should not have a trailing slash (must not be null).

asURI

public java.net.URI asURI(java.lang.String uriString)

Returns the given string as URI if possible. In contrary to the constructor of URI this method throws a runtime exception.

Parameters:

uriString - The string to be converted to a URI (must not be null).

Returns:

The URI created from the given string.

Throws:

InvalidUrlException - if the given string is no valid URI.

asURL

public java.net.URL asURL(java.lang.String urlString)

Returns the given string as URL if possible. In contrary to the constructor of URL this method throws a runtime exception.

Parameters:

urlString - The string to be converted to a URL (must not be null).

Returns:

The URL created from the given string.

Throws:

InvalidUrlException - if the given string is no valid URL.

str

protected StringUtil str()