com.atlassian.bitbucket.content

Enum DiffFileType

java.lang.Object

java.lang.Enum<DiffFileType>

com.atlassian.bitbucket.content.DiffFileType

All Implemented Interfaces:

Serializable, Comparable<DiffFileType>

public enum DiffFileType
extends Enum<DiffFileType>

An enumeration of file types in a diff.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FROM The source ('from') file of the diff.
TO The destination ('to') file of the diff,

Method Summary

Modifier and Type	Method and Description
static DiffFileType	forSegmentType(DiffSegmentType segmentType) Returns the default file type for a given segmentType.
static DiffFileType	fromId(int id)
int	getId()
static DiffFileType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiffFileType[]	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

FROM

public static final DiffFileType FROM

The source ('from') file of the diff.

TO

public static final DiffFileType TO

The destination ('to') file of the diff,

Method Detail

values

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

Returns:

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

valueOf

public static DiffFileType 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

forSegmentType

@Nonnull
public static DiffFileType forSegmentType(@Nonnull
                                                   DiffSegmentType segmentType)

Returns the default file type for a given segmentType.

Parameters:

segmentType - segment type to match

Returns:

the default matching file type for the provided segment type

Throws:

IllegalArgumentException - if there is no file type currently associated with segmentType.

fromId

@Nonnull
public static DiffFileType fromId(int id)

getId

public int getId()