Package com.github.jamesnetherton.zulip.client.api.narrow

Class Narrow

java.lang.Object

com.github.jamesnetherton.zulip.client.api.narrow.Narrow

public class Narrow
extends Object

A narrow is a set of filters for Zulip messages.

See Also:

• https://zulip.com/api/construct-narrow

Constructor Summary

Constructors

Constructor	Description
Narrow(String operator, Integer operand, boolean negated)	Constructs a Narrow with an Integer operand.
Narrow(String operator, Long operand, boolean negated)	Constructs a Narrow with an Long operand.
Narrow(String operator, String operand, boolean negated)	Constructs a Narrow with a String operand.
Narrow(String operator, List<? extends Number> operand, boolean negated)	Constructs a Narrow with an numeric List operand.

Method Summary

Modifier and Type	Method	Description
Object	getOperand()
String	getOperator()
boolean	isNegated()
static Narrow	of(String operator, Integer operand)	Creates a Narrow.
static Narrow	of(String operator, Long operand)	Creates a Narrow.
static Narrow	of(String operator, String operand)	Creates a Narrow.
static Narrow	of(String operator, List<? extends Number> operand)	Creates a Narrow.
static Narrow	ofNegated(String operator, String operand)	Creates a negated Narrow.

Methods inherited from class java.lang.Object

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

Constructor Details

Narrow

public Narrow(String operator,
 String operand,
 boolean negated)

Constructs a Narrow with a String operand.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

negated - Whether the narrow is negated

Narrow

public Narrow(String operator,
 Integer operand,
 boolean negated)

Constructs a Narrow with an Integer operand.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

negated - Whether the narrow is negated

Narrow

public Narrow(String operator,
 Long operand,
 boolean negated)

Constructs a Narrow with an Long operand.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

negated - Whether the narrow is negated

Narrow

public Narrow(String operator,
 List<? extends Number> operand,
 boolean negated)

Constructs a Narrow with an numeric List operand.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

negated - Whether the narrow is negated

Method Details

of

public static Narrow of(String operator,
 String operand)

Creates a Narrow.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

Returns:

The Narrow constructed from the operator and operand

of

public static Narrow of(String operator,
 Integer operand)

Creates a Narrow.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

Returns:

The Narrow constructed from the operator and operand

of

public static Narrow of(String operator,
 Long operand)

Creates a Narrow.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

Returns:

The Narrow constructed from the operator and operand

of

public static Narrow of(String operator,
 List<? extends Number> operand)

Creates a Narrow.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

Returns:

The Narrow constructed from the operator and operand

ofNegated

public static Narrow ofNegated(String operator,
 String operand)

Creates a negated Narrow.

Parameters:

operator - The operator that the narrow will apply to

operand - The operand that the narrow will apply to

Returns:

The negated Narrow constructed from the operator and operand

getOperator

public String getOperator()

getOperand

public Object getOperand()

isNegated

public boolean isNegated()