com.github.jamesnetherton.zulip.client.api.narrow.Narrow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zulip-java-client Show documentation

Java client for the Zulip REST API

The newest version!

package com.github.jamesnetherton.zulip.client.api.narrow;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * A narrow is a set of filters for Zulip messages.
 *
 * @see https://zulip.com/api/construct-narrow
 */
public class Narrow {

    @JsonProperty
    private final String operator;

    @JsonProperty
    private final String operand;

    @JsonProperty
    private final boolean negated;

    /**
     * Constructs a {@link Narrow}.
     *
     * @param operator The operator that the narrow will apply to
     * @param operand  The operand that the narrow will apply to
     * @param negated  Whether the narrow is negated
     */
    public Narrow(String operator, String operand, boolean negated) {
        this.operator = operator;
        this.operand = operand;
        this.negated = negated;
    }

    /**
     * Creates a {@link Narrow}.
     *
     * @param  operator The operator that the narrow will apply to
     * @param  operand  The operand that the narrow will apply to
     * @return          The {@link Narrow} constructed from the operator and operand
     */
    public static Narrow of(String operator, String operand) {
        return new Narrow(operator, operand, false);
    }

    /**
     * Creates a negated {@link Narrow}.
     *
     * @param  operator The operator that the narrow will apply to
     * @param  operand  The operand that the narrow will apply to
     * @return          The negated {@link Narrow} constructed from the operator and operand
     */
    public static Narrow ofNegated(String operator, String operand) {
        return new Narrow(operator, operand, true);
    }

    public String getOperator() {
        return operator;
    }

    public String getOperand() {
        return operand;
    }

    public boolean isNegated() {
        return negated;
    }
}