jetbrains.buildServer.web.openapi
Class PositionConstraint

java.lang.Object
  jetbrains.buildServer.web.openapi.PositionConstraint

All Implemented Interfaces:

java.lang.Comparable<PageExtension>

public abstract class PositionConstraint
extends java.lang.Object
implements java.lang.Comparable<PageExtension>

Represents extension position constraints within single page place

Since:

5.1

Field Summary

static PositionConstraint

UNDEFINED

Method Summary

static PositionConstraint	after(java.lang.String... ids) Indicates that extension must be placed after other extensions with specified identifiers (plugin names)
static PositionConstraint	before(java.lang.String... ids) Indicates that extension must be placed before other extensions with specified identifiers (plugin names)
static PositionConstraint	between(java.util.Collection<java.lang.String> afterIds, java.util.Collection<java.lang.String> beforeIds) Indicates that extension must be placed between other extensions.
abstract PositionConstraint	convert()
static PositionConstraint	first() Indicates that extension must be the first.
static PositionConstraint	last() Indicates that extension must be the last.
abstract java.lang.String	toString() Human readable presentation of the constraint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

UNDEFINED

public static final PositionConstraint UNDEFINED

Method Detail

first

@NotNull
public static PositionConstraint first()

Indicates that extension must be the first.

Returns:

new constraint

last

@NotNull
public static PositionConstraint last()

Indicates that extension must be the last.

Returns:

new constraint

before

@NotNull
public static PositionConstraint before(@NotNull
                                                java.lang.String... ids)

Indicates that extension must be placed before other extensions with specified identifiers (plugin names)

Parameters:

ids - extensions identifiers (plugin names)

Returns:

new constraint

after

@NotNull
public static PositionConstraint after(@NotNull
                                               java.lang.String... ids)

Indicates that extension must be placed after other extensions with specified identifiers (plugin names)

Parameters:

ids - extensions identifiers (plugin names)

Returns:

new constraint

between

@NotNull
public static PositionConstraint between(@NotNull
                                                 java.util.Collection<java.lang.String> afterIds,
                                                 @NotNull
                                                 java.util.Collection<java.lang.String> beforeIds)

Indicates that extension must be placed between other extensions.

Parameters:

afterIds - the extension will be placed after the extensions with provided ids

beforeIds - the extension will be placed before the extensions with provided ids

Returns:

new constraint

toString

public abstract java.lang.String toString()

Human readable presentation of the constraint.

Overrides:

toString in class java.lang.Object

Returns:

see above

convert

public abstract PositionConstraint convert()