com.addthis.codec.plugins

Class PluginMap

java.lang.Object

com.addthis.codec.plugins.PluginMap

@Beta
public class PluginMap
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static PluginMap	EMPTY

Constructor Summary

Constructors

Constructor and Description
PluginMap(String category, com.typesafe.config.Config config)

Method Summary

Methods

Modifier and Type	Method and Description
com.typesafe.config.ConfigObject	aliasDefaults(String alias)
Class<?>	arraySugar()
com.google.common.collect.BiMap<String,Class<?>>	asBiMap()
Class<?>	baseClass() The base class, if any, that all configured plugins must be assignable to.
String	category()
String	classField()
com.typesafe.config.Config	config()
Class<?>	defaultSugar()
Class<?>	getClass(String type) Resolves aliases until the root class for that alias chain is found or if no such alias exsits, then try find and validate the given string as if it were the class name of an anonymous alias.
Class<?>	getClassIfConfigured(String type) Like getClass(String), but will return null rather than try to locate a new class.
String	getClassName(Class<?> type) Reverse look-up on the bi-map to get the root alias for this type; if none, then returns the class name
String	getLastAlias(String alias) Resolves aliases that point to other aliases until pointing to a real class; then return the current label.
Set<String>	inlinedAliases()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final PluginMap EMPTY

Constructor Detail

PluginMap

public PluginMap(@Nonnull
         String category,
         @Nonnull
         com.typesafe.config.Config config)

Method Detail

asBiMap

@Nonnull
public com.google.common.collect.BiMap<String,Class<?>> asBiMap()

config

@Nonnull
public com.typesafe.config.Config config()

aliasDefaults

@Nonnull
public com.typesafe.config.ConfigObject aliasDefaults(String alias)

classField

@Nonnull
public String classField()

category

@Nonnull
public String category()

inlinedAliases

@Nonnull
public Set<String> inlinedAliases()

arraySugar

@Nullable
public Class<?> arraySugar()

defaultSugar

@Nullable
public Class<?> defaultSugar()

baseClass

@Nullable
public Class<?> baseClass()

The base class, if any, that all configured plugins must be assignable to.

getClassName

@Nonnull
public String getClassName(Class<?> type)

Reverse look-up on the bi-map to get the root alias for this type; if none, then returns the class name

getLastAlias

@Nullable
public String getLastAlias(String alias)

Resolves aliases that point to other aliases until pointing to a real class; then return the current label.

getClass

@Nonnull
public Class<?> getClass(String type)
                  throws ClassNotFoundException

Resolves aliases until the root class for that alias chain is found or if no such alias exsits, then try find and validate the given string as if it were the class name of an anonymous alias. This means that it if a base _class is defined for this category that all package prefixes will be tried and that any found class must be assignable to the base _class type.

Throws:

ClassNotFoundException

getClassIfConfigured

@Nullable
public Class<?> getClassIfConfigured(String type)

Like getClass(String), but will return null rather than try to locate a new class.

toString

public String toString()

Overrides:

toString in class Object