com.smoketurner.notification.api.Rule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of notification-api Show documentation
There is a newer version: 2.0.0
/*
 * Copyright © 2018 Smoke Turner, LLC ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.smoketurner.notification.api;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.MoreObjects;
import io.dropwizard.jackson.JsonSnakeCase;
import io.dropwizard.util.Duration;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

@Immutable
@JsonSnakeCase
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public final class Rule {

  public static final String MAX_SIZE = "max_size";
  public static final String MAX_DURATION = "max_duration";
  public static final String MATCH_ON = "match_on";

  private final Optional maxSize;
  private final Optional maxDuration;
  private final Optional matchOn;

  /**
   * Constructor
   *
   * @param maxSize Maximum number of notifications to include in a roll-up
   * @param maxDuration Maximum time duration between the first and last notifications in a roll-up
   * @param matchOn Group notifications by a specific category
   */
  @JsonCreator
  private Rule(
      @JsonProperty(MAX_SIZE) final Optional maxSize,
      @JsonProperty(MAX_DURATION) final Optional maxDuration,
      @JsonProperty(MATCH_ON) final Optional matchOn) {
    this.maxSize = maxSize;
    this.maxDuration = maxDuration;
    if (matchOn.isPresent()) {
      if (matchOn.get().isEmpty()) {
        this.matchOn = Optional.empty();
      } else {
        this.matchOn = matchOn;
      }
    } else {
      this.matchOn = Optional.empty();
    }
  }

  public static Builder builder() {
    return new Builder();
  }

  public static class Builder {
    @Nullable private Integer maxSize;

    @Nullable private Duration maxDuration;

    @Nullable private String matchOn;

    public Builder withMaxSize(@Nullable final Integer maxSize) {
      this.maxSize = maxSize;
      return this;
    }

    public Builder withMaxDuration(@Nullable final Duration maxDuration) {
      this.maxDuration = maxDuration;
      return this;
    }

    public Builder withMatchOn(@Nullable final String matchOn) {
      if (matchOn != null && matchOn.isEmpty()) {
        this.matchOn = null;
      } else {
        this.matchOn = matchOn;
      }
      return this;
    }

    public Rule build() {
      return new Rule(
          Optional.ofNullable(maxSize),
          Optional.ofNullable(maxDuration),
          Optional.ofNullable(matchOn));
    }
  }

  @JsonProperty(MAX_SIZE)
  public Optional getMaxSize() {
    return maxSize;
  }

  @JsonProperty(MAX_DURATION)
  public Optional getMaxDuration() {
    return maxDuration;
  }

  @JsonProperty(MATCH_ON)
  public Optional getMatchOn() {
    return matchOn;
  }

  @JsonIgnore
  public boolean isValid() {
    return maxSize.isPresent() || maxDuration.isPresent() || matchOn.isPresent();
  }

  @Override
  public boolean equals(@Nullable final Object obj) {
    if (this == obj) {
      return true;
    }
    if ((obj == null) || (getClass() != obj.getClass())) {
      return false;
    }

    final Rule other = (Rule) obj;
    return Objects.equals(maxSize, other.maxSize)
        && Objects.equals(maxDuration, other.maxDuration)
        && Objects.equals(matchOn, other.matchOn);
  }

  @Override
  public int hashCode() {
    return Objects.hash(maxSize, maxDuration, matchOn);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("maxSize", maxSize)
        .add("maxDuration", maxDuration)
        .add("matchOn", matchOn)
        .toString();
  }
}