IMapEntry.EntryType (Perforce Java API 2015.1.1210280 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

com.perforce.p4java.core
Enum IMapEntry.EntryType

java.lang.Object
  java.lang.Enum<IMapEntry.EntryType>
      com.perforce.p4java.core.IMapEntry.EntryType

All Implemented Interfaces:: Serializable, Comparable<IMapEntry.EntryType>

Enclosing interface:: IMapEntry

public static enum IMapEntry.EntryType
extends Enum<IMapEntry.EntryType>
extends Enum<IMapEntry.EntryType>

Defines the specific type of a given view map entry.

Enum Constant Summary
`EXCLUDE` Specifies this is an "exclude" mapping; this means that the map excludes this path and its children.
`INCLUDE` Specifies this is an "include" mapping; this means that the map includes this path and its children.
`OVERLAY` Specifies this is an "overlay" mapping; this means that the map overlays this path and its children.

Method Summary
`static IMapEntry.EntryType`	`fromString(String str)` Return a suitable EntryType as inferred from the passed-in string, which is assumed to be a Perforce view map path string.
`String`	`toString()` Return a more useful string than "EXCLUDE" or "OVERLAY", i.e.
`static IMapEntry.EntryType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IMapEntry.EntryType[]`	`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

INCLUDE

public static final IMapEntry.EntryType INCLUDE

Specifies this is an "include" mapping; this means that the map includes this path and its children.

EXCLUDE

public static final IMapEntry.EntryType EXCLUDE

Specifies this is an "exclude" mapping; this means that the map excludes this path and its children.

OVERLAY

public static final IMapEntry.EntryType OVERLAY

Specifies this is an "overlay" mapping; this means that the map overlays this path and its children.

Method Detail

values

public static IMapEntry.EntryType[] 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 (IMapEntry.EntryType c : IMapEntry.EntryType.values())
    System.out.println(c);

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

valueOf

public static IMapEntry.EntryType 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

fromString

public static IMapEntry.EntryType fromString(String str)

Return a suitable EntryType as inferred from the passed-in string, which is assumed to be a Perforce view map path string. If str is null, or no such EntryType can be inferred, returns null.

toString

public String toString()

Return a more useful string than "EXCLUDE" or "OVERLAY", i.e. return "-" or "+" respectively. Returns the empty string (not null) if the type is neither EXCLUDE nor OVERLAY.