com.inductiveautomation.ignition.common.project

Enum ProjectCommitMessageMode

java.lang.Object

java.lang.Enum<ProjectCommitMessageMode>

com.inductiveautomation.ignition.common.project.ProjectCommitMessageMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProjectCommitMessageMode>

public enum ProjectCommitMessageMode
extends java.lang.Enum<ProjectCommitMessageMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
None The designer never asks for commit messages.
OnPublish The user will be prompted for a commit message when the project is published.
OnSaveAndPublish The user will be prompted for a commit message when the project is saved or published.

Method Summary

Modifier and Type	Method and Description
static ProjectCommitMessageMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProjectCommitMessageMode[]	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

None

public static final ProjectCommitMessageMode None

The designer never asks for commit messages.

OnPublish

public static final ProjectCommitMessageMode OnPublish

The user will be prompted for a commit message when the project is published.

OnSaveAndPublish

public static final ProjectCommitMessageMode OnSaveAndPublish

The user will be prompted for a commit message when the project is saved or published.

Method Detail

values

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

Returns:

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

valueOf

public static ProjectCommitMessageMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null