Top Description Methods
org.springframework.core

public Interface AliasRegistry

Known Direct Implementers
org.springframework.core.SimpleAliasRegistry
Common interface for managing aliases. Serves as a super-interface for org.springframework.beans.factory.support.BeanDefinitionRegistry.
Author
Juergen Hoeller
Since
2.5.2

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

the aliases, or an empty array if none
getAliases(String
the name to check for aliases
name)

Return the aliases for the given name, if defined.

public boolean

Returns:

whether the given name is an alias
isAlias(String
the name to check
name)

Determine whether the given name is defined as an alias (as opposed to the name of an actually registered component).

public void
registerAlias(String
the canonical name
name, String
the alias to be registered
alias)

Given a name, register an alias for it.

public void
removeAlias(String
the alias to remove
alias)

Remove the specified alias from this registry.

Method Detail

getAliasesback to summary
public String[] getAliases(String name)

Return the aliases for the given name, if defined.

Parameters
name:String

the name to check for aliases

Returns:String[]

the aliases, or an empty array if none

isAliasback to summary
public boolean isAlias(String name)

Determine whether the given name is defined as an alias (as opposed to the name of an actually registered component).

Parameters
name:String

the name to check

Returns:boolean

whether the given name is an alias

registerAliasback to summary
public void registerAlias(String name, String alias)

Given a name, register an alias for it.

Parameters
name:String

the canonical name

alias:String

the alias to be registered

Exceptions
IllegalStateException:
if the alias is already in use and may not be overridden
removeAliasback to summary
public void removeAlias(String alias)

Remove the specified alias from this registry.

Parameters
alias:String

the alias to remove

Exceptions
IllegalStateException:
if no such alias was found