org.glassfish.hk2
Interface Descriptor


public interface Descriptor

A Descriptor is a bean-like structure that describes a service declaration in HK2.

Services have a number of optional attributes such as name and scope. A service is required to minimally have a type name representing the concrete (i.e., byType) definition.

Author:
Jerome Dochez, Jeff Trent, Mason Taube

Method Summary
 java.util.Collection<java.lang.String> getContracts()
          The contracts that are used to index the service definition.
 MultiMap<java.lang.String,java.lang.String> getMetadata()
          The meta data attributes for the service.
 java.lang.String getName()
          The optional name for the service.
 java.util.Collection<java.lang.String> getQualifiers()
          Returns the qualifier annotations on the service.
 java.lang.String getTypeName()
          The implementation definition type.
 

Method Detail

getName

java.lang.String getName()
The optional name for the service.

Returns:
service's name or null if none provided

getMetadata

MultiMap<java.lang.String,java.lang.String> getMetadata()
The meta data attributes for the service.

Returns:
the service's metadata

getQualifiers

java.util.Collection<java.lang.String> getQualifiers()
Returns the qualifier annotations on the service.

Returns:
a collection of qualifiers for this service.

getContracts

java.util.Collection<java.lang.String> getContracts()
The contracts that are used to index the service definition.

Returns:
the collection of contracts fqcn.

getTypeName

java.lang.String getTypeName()
The implementation definition type.

Returns:
the fcqn of the implementation.


Copyright © 2011 Oracle Corporation. All Rights Reserved.