Module org.refcodes.web

Package org.refcodes.web

Interface SchemeAccessor

All Known Subinterfaces:

HttpServerContext, SchemeAccessor.SchemeProperty

All Known Implementing Classes:

HttpServerContextBuilder, Url, UrlBuilder

public interface SchemeAccessor

Provides an accessor for a URL scheme.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SchemeAccessor.SchemeBuilder<B extends SchemeAccessor.SchemeBuilder<B>>	Provides a builder method for a URL scheme returning the builder for applying multiple build operations.
static interface	SchemeAccessor.SchemeMutator	Provides a mutator for a URL scheme.
static interface	SchemeAccessor.SchemeProperty	Provides a URL scheme.

Method Summary

Modifier and Type	Method	Description
org.refcodes.data.Scheme	getScheme()	Retrieves the UrlScheme from the URL scheme.
String	toProtocol()	Retrieves the protocol representation from the Scheme.

Method Details

getScheme

org.refcodes.data.Scheme getScheme()

Retrieves the UrlScheme from the URL scheme.

Returns:

The UrlScheme stored by the URL scheme.

toProtocol

String toProtocol()

Retrieves the protocol representation from the Scheme. In case of a scheme unknown by the Scheme enumeration, then getScheme() might return null whilst toProtocol() still retrieves the unknown scheme's protocol representation (as of SchemeAccessor.SchemeMutator.setProtocol(String)).

Returns:

The protocol representation for the URL.