com.android.jill.api
Interface JillProvider

public interface JillProvider

Provides instances of JillConfig.

Nested Class Summary

static class

JillProvider.SubReleaseKind The kind of sub-release.

Method Summary

<T extends JillConfig> T	createConfig(java.lang.Class<T> cls) Creates a JillConfig instance for an interface representing a JillConfig API version.
java.util.Collection<java.lang.Class<? extends JillConfig>>	getSupportedConfigs() Gives a Collection containing supported JillConfig API versions.
java.lang.String	getTranslatorBuildId() The build ID of this Jill.
int	getTranslatorReleaseCode() Gives an integer value that represents the release of this Jill, relative to other releases.
java.lang.String	getTranslatorReleaseName() Gives the release name of this Jill (e.g.
java.lang.String	getTranslatorSourceCodeBase() Identify the source code base of this Jill.
int	getTranslatorSubReleaseCode() Gives an integer value that represents the sub-release of this Jill, relative to other sub-releases of the same release.
JillProvider.SubReleaseKind	getTranslatorSubReleaseKind() Gives the kind of sub-release of this Jill.
java.lang.String	getTranslatorVersion() Gives the version of this Jill, summarized in one string (e.g.
<T extends JillConfig> boolean	isConfigSupported(java.lang.Class<T> cls) Returns whether an interface representing a JillConfig API version is supported.

Method Detail

createConfig

@Nonnull
<T extends JillConfig> T createConfig(@Nonnull
                                              java.lang.Class<T> cls)
                                  throws ConfigNotSupportedException

Creates a JillConfig instance for an interface representing a JillConfig API version.

Parameters:

cls - the JillConfig API interface

Returns:

the JillConfig instance

Throws:

ConfigNotSupportedException - If no implementation is found for the given interface.

isConfigSupported

@Nonnull
<T extends JillConfig> boolean isConfigSupported(@Nonnull
                                                         java.lang.Class<T> cls)

Returns whether an interface representing a JillConfig API version is supported.

Parameters:

cls - the JillConfig API interface

Returns:

true if the config is supported

getSupportedConfigs

@Nonnull
java.util.Collection<java.lang.Class<? extends JillConfig>> getSupportedConfigs()

Gives a Collection containing supported JillConfig API versions.

Returns:

the supported JillConfig API versions

getTranslatorVersion

@Nonnull
java.lang.String getTranslatorVersion()

Gives the version of this Jill, summarized in one string (e.g. "1.1-rc1", "2.0-a2", ...).

Returns:

the version

getTranslatorReleaseName

@Nonnull
java.lang.String getTranslatorReleaseName()

Gives the release name of this Jill (e.g. Arzon, Brest, ...).

Returns:

the release name

getTranslatorReleaseCode

@Nonnegative
int getTranslatorReleaseCode()

Gives an integer value that represents the release of this Jill, relative to other releases.

Returns:

the release code

getTranslatorSubReleaseCode

@Nonnegative
int getTranslatorSubReleaseCode()

Gives an integer value that represents the sub-release of this Jill, relative to other sub-releases of the same release.

Returns:

the sub-release code

getTranslatorSubReleaseKind

@Nonnull
JillProvider.SubReleaseKind getTranslatorSubReleaseKind()

Gives the kind of sub-release of this Jill.

Returns:

the sub-release kind

getTranslatorBuildId

@CheckForNull
java.lang.String getTranslatorBuildId()

The build ID of this Jill.

Returns:

the build ID, or null if not available

getTranslatorSourceCodeBase

@CheckForNull
java.lang.String getTranslatorSourceCodeBase()

Identify the source code base of this Jill.

Returns:

the source code base, or null if not available