org.sonatype.guice.plexus.config
Class Hints

java.lang.Object
  extended by org.sonatype.guice.plexus.config.Hints

public final class Hints
extends java.lang.Object

Constants and utility methods for dealing with Plexus hints.


Field Summary
static java.lang.String DEFAULT_HINT
           
static java.lang.String[] NO_HINTS
           
 
Method Summary
static java.lang.String canonicalHint(java.lang.String hint)
          Returns the canonical form of the given Plexus hint.
static java.util.List<java.lang.String> canonicalHints(java.util.List<java.lang.String> hints)
          Returns the canonical form of the given Plexus hints.
static java.lang.String[] canonicalHints(org.codehaus.plexus.component.annotations.Requirement requirement)
          Returns the Plexus hints contained in the given @Requirement.
static java.lang.String[] canonicalHints(java.lang.String... hints)
          Returns the canonical form of the given Plexus hints.
static boolean isDefaultHint(java.lang.String hint)
          Determines if the given Plexus hint denotes the default component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_HINTS

public static final java.lang.String[] NO_HINTS

DEFAULT_HINT

public static final java.lang.String DEFAULT_HINT
See Also:
Constant Field Values
Method Detail

canonicalHint

public static java.lang.String canonicalHint(java.lang.String hint)
Returns the canonical form of the given Plexus hint.

Parameters:
hint - The Plexus hint
Returns:
Canonical hint denoting the same component as the given hint

isDefaultHint

public static boolean isDefaultHint(java.lang.String hint)
Determines if the given Plexus hint denotes the default component.

Parameters:
hint - The Plexus hint
Returns:
true if the given hint denotes the default component

canonicalHints

public static java.lang.String[] canonicalHints(java.lang.String... hints)
Returns the canonical form of the given Plexus hints.

Parameters:
hints - The Plexus hints
Returns:
Array of canonical hints

canonicalHints

public static java.util.List<java.lang.String> canonicalHints(java.util.List<java.lang.String> hints)
Returns the canonical form of the given Plexus hints.

Parameters:
hints - The Plexus hints
Returns:
List of canonical hints

canonicalHints

public static java.lang.String[] canonicalHints(org.codehaus.plexus.component.annotations.Requirement requirement)
Returns the Plexus hints contained in the given @Requirement.

Parameters:
requirement - The Plexus requirement
Returns:
Array of canonical hints


Copyright © 2010-2011 Sonatype, Inc.. All Rights Reserved.