IStreamSummary.Type (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 IStreamSummary.Type

java.lang.Object
  java.lang.Enum<IStreamSummary.Type>
      com.perforce.p4java.core.IStreamSummary.Type

All Implemented Interfaces:: Serializable, Comparable<IStreamSummary.Type>

Enclosing interface:: IStreamSummary

public static enum IStreamSummary.Type
extends Enum<IStreamSummary.Type>
extends Enum<IStreamSummary.Type>

Types of streams include 'mainline', 'release', 'development', 'virtual' and 'task'. The default is 'development'.

Defines the role of a stream: A 'mainline' may not have a parent. A 'virtual' stream is not a stream but an alternate view of its parent stream. The 'development' and 'release' streams have controlled flow. Can be changed. A 'task' stream is a lightweight short-lived stream that only promotes modified content to the repository, branched data is stored in shadow tables that are removed when the task stream is deleted or unloaded.

Enum Constant Summary
`DEVELOPMENT`
`MAINLINE`
`RELEASE`
`TASK`
`UNKNOWN`
`VIRTUAL`

Method Summary
`static IStreamSummary.Type`	`fromString(String str)` Return a suitable Stream type as inferred from the passed-in string, which is assumed to be the string form of a Stream type.
`static IStreamSummary.Type`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static IStreamSummary.Type[]`	`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, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

MAINLINE

public static final IStreamSummary.Type MAINLINE

RELEASE

public static final IStreamSummary.Type RELEASE

DEVELOPMENT

public static final IStreamSummary.Type DEVELOPMENT

VIRTUAL

public static final IStreamSummary.Type VIRTUAL

TASK

public static final IStreamSummary.Type TASK

UNKNOWN

public static final IStreamSummary.Type UNKNOWN

Method Detail

values

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

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

valueOf

public static IStreamSummary.Type 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 IStreamSummary.Type fromString(String str)

Return a suitable Stream type as inferred from the passed-in string, which is assumed to be the string form of a Stream type. Otherwise return the UNKNOWN Stream type