Package org.xwiki.eventstream.query

Class SortableEventQuery.SortClause

java.lang.Object

org.xwiki.eventstream.query.SortableEventQuery.SortClause

Enclosing interface:

SortableEventQuery

public static class SortableEventQuery.SortClause
extends Object

The sort clause to apply to the found events.

Version:

$Id: 4c8615d938488c5d35db82988ae75554b0bf2b08 $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SortableEventQuery.SortClause.Order	The order to apply.

Constructor Summary

Constructors

Constructor	Description
SortClause(String property, boolean custom, Type customType, SortableEventQuery.SortClause.Order order)
SortClause(String property, boolean custom, SortableEventQuery.SortClause.Order order)
SortClause(String property, SortableEventQuery.SortClause.Order order)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Type	getCustomType()
SortableEventQuery.SortClause.Order	getOrder()
String	getProperty()
int	hashCode()
boolean	isCustom()
boolean	isParameter()	Deprecated. use isCustom() instead
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SortClause

public SortClause(String property,
                  SortableEventQuery.SortClause.Order order)

Parameters:

property - see getProperty()

order - see getOrder()

SortClause

public SortClause(String property,
                  boolean custom,
                  SortableEventQuery.SortClause.Order order)

Parameters:

property - see getProperty()

custom - see isCustom()

order - see getOrder()

Since:

13.9RC1

SortClause

public SortClause(String property,
                  boolean custom,
                  Type customType,
                  SortableEventQuery.SortClause.Order order)

Parameters:

property - see getProperty()

custom - see isCustom()

customType - see getCustomType()

order - see getOrder()

Since:

14.2RC1

Method Detail

getProperty

public String getProperty()

Returns:

the property to sort on

isParameter

@Deprecated(since="13.9RC1")
public boolean isParameter()

Deprecated.

use isCustom() instead

Returns:

true if it's a custom event parameter

Since:

13.9RC1

isCustom

public boolean isCustom()

Returns:

true if it's a custom event parameter

Since:

14.2RC1

getCustomType

public Type getCustomType()

Returns:

the type in which that property was stored

Since:

14.2RC1

getOrder

public SortableEventQuery.SortClause.Order getOrder()

Returns:

the order to apply (ascending or descending)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object