ShrinkWrap Resolver Maven API 2.0.0-cr-1

org.jboss.shrinkwrap.resolver.api.maven
Enum ScopeType

java.lang.Object
  extended by java.lang.Enum<ScopeType>
      extended by org.jboss.shrinkwrap.resolver.api.maven.ScopeType
All Implemented Interfaces:
Serializable, Comparable<ScopeType>

public enum ScopeType
extends Enum<ScopeType>

Valid scope types for Maven MavenDependency metadata

Author:
Andrew Lee Rubinger, Karel Piwko

Enum Constant Summary
COMPILE
           
IMPORT
           
PROVIDED
           
RUNTIME
           
SYSTEM
           
TEST
           
 
Method Summary
static ScopeType fromScopeType(String scopeName)
          Maps a string to ScopeType
 String toString()
          Returns the value of this enum
static ScopeType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ScopeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

COMPILE

public static final ScopeType COMPILE

PROVIDED

public static final ScopeType PROVIDED

RUNTIME

public static final ScopeType RUNTIME

TEST

public static final ScopeType TEST

SYSTEM

public static final ScopeType SYSTEM

IMPORT

public static final ScopeType IMPORT
Method Detail

values

public static ScopeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ScopeType c : ScopeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScopeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

toString

public String toString()
Returns the value of this enum

Overrides:
toString in class Enum<ScopeType>
See Also:
Enum.toString()

fromScopeType

public static ScopeType fromScopeType(String scopeName)
                               throws IllegalArgumentException
Maps a string to ScopeType

Parameters:
scopeName - String name of the scope type
Returns:
Corresponding ScopeType object
Throws:
IllegalArgumentException - Thrown if scopeName is null, empty or does not represent a valid scope type

ShrinkWrap Resolver Maven API 2.0.0-cr-1

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.