to top
Android APIs
public final class

SchemeRegistry

extends Object
java.lang.Object
   ↳ org.apache.http.conn.scheme.SchemeRegistry

Class Overview

A set of supported protocol schemes. Schemes are identified by lowercase names.

Summary

Public Constructors
SchemeRegistry()
Creates a new, empty scheme registry.
Public Methods
synchronized final Scheme get( String name)
Obtains a scheme by name, if registered.
synchronized final Scheme getScheme( String name)
Obtains a scheme by name.
synchronized final Scheme getScheme( HttpHost host)
Obtains the scheme for a host.
synchronized final List< String> getSchemeNames()
Obtains the names of the registered schemes in their default order.
synchronized final Scheme register( Scheme sch)
Registers a scheme.
synchronized void setItems( Map< String,  Scheme> map)
Populates the internal collection of registered protocol schemes with the content of the map passed as a parameter.
synchronized final Scheme unregister( String name)
Unregisters a scheme.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SchemeRegistry ()

Added in API level 1

Creates a new, empty scheme registry.

Public Methods

public final synchronized Scheme get (String name)

Added in API level 1

Obtains a scheme by name, if registered.

Parameters
name the name of the scheme to look up (in lowercase)
Returns
  • the scheme, or null if there is none by this name

public final synchronized Scheme getScheme (String name)

Added in API level 1

Obtains a scheme by name.

Parameters
name the name of the scheme to look up (in lowercase)
Returns
  • the scheme, never null
Throws
IllegalStateException if the scheme with the given name is not registered

public final synchronized Scheme getScheme (HttpHost host)

Added in API level 1

Obtains the scheme for a host. Convenience method for getScheme(host.getSchemeName())

Parameters
host the host for which to obtain the scheme
Returns
  • the scheme for the given host, never null
Throws
IllegalStateException if a scheme with the respective name is not registered

public final synchronized List<String> getSchemeNames ()

Added in API level 1

Obtains the names of the registered schemes in their default order.

Returns
  • List containing registered scheme names.

public final synchronized Scheme register (Scheme sch)

Added in API level 1

Registers a scheme. The scheme can later be retrieved by its name using getScheme or get.

Parameters
sch the scheme to register
Returns
  • the scheme previously registered with that name, or null if none was registered

public synchronized void setItems (Map<String, Scheme> map)

Added in API level 1

Populates the internal collection of registered protocol schemes with the content of the map passed as a parameter.

Parameters
map protocol schemes

public final synchronized Scheme unregister (String name)

Added in API level 1

Unregisters a scheme.

Parameters
name the name of the scheme to unregister (in lowercase)
Returns
  • the unregistered scheme, or null if there was none
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.