com.atlassian.jira.jql.resolver
Class ComponentResolver

java.lang.Object
  extended by com.atlassian.jira.jql.resolver.ComponentResolver
All Implemented Interfaces:
NameResolver<ProjectComponent>

public class ComponentResolver
extends Object
implements NameResolver<ProjectComponent>

Resolves Component objects and ids from their names.

Since:
v4.0

Constructor Summary
ComponentResolver(ProjectComponentManager componentManager)
           
 
Method Summary
 ProjectComponent get(Long id)
          Get by id.
 Collection<ProjectComponent> getAll()
          Gets all domain objects of this type in the underlying database.
 List<String> getIdsFromName(String name)
          Returns the list of ids of T objects that have the given name.
 boolean idExists(Long id)
          Returns true if the id would resolve to a domain object.
 boolean nameExists(String name)
          Returns true if the name would resolve to a domain object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ComponentResolver

public ComponentResolver(ProjectComponentManager componentManager)
Method Detail

getIdsFromName

public List<String> getIdsFromName(String name)
Description copied from interface: NameResolver
Returns the list of ids of T objects that have the given name. Names may be unique but often are not, hence the List return type.

Specified by:
getIdsFromName in interface NameResolver<ProjectComponent>
Parameters:
name - the name of the T.
Returns:
all IDs of objects matching the name or the empty list on name lookup failure.

nameExists

public boolean nameExists(String name)
Description copied from interface: NameResolver
Returns true if the name would resolve to a domain object.

Specified by:
nameExists in interface NameResolver<ProjectComponent>
Parameters:
name - the addressable name.
Returns:
true only if the name resolves to a domain object in the database.

idExists

public boolean idExists(Long id)
Description copied from interface: NameResolver
Returns true if the id would resolve to a domain object.

Specified by:
idExists in interface NameResolver<ProjectComponent>
Parameters:
id - the primary key.
Returns:
true only if the id resolves to a domain object in the database.

get

public ProjectComponent get(Long id)
Description copied from interface: NameResolver
Get by id.

Specified by:
get in interface NameResolver<ProjectComponent>
Parameters:
id - the id.
Returns:
the domain object or null on lookup failure.

getAll

public Collection<ProjectComponent> getAll()
Description copied from interface: NameResolver
Gets all domain objects of this type in the underlying database. Note that calling this may not be a good idea for some domain object types.

Specified by:
getAll in interface NameResolver<ProjectComponent>
Returns:
all objects of the configured type in the database (possibly empty, never null).


Copyright © 2002-2012 Atlassian. All Rights Reserved.