com.google.gerrit.entities.LegacySubmitRequirement Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation

API for Gerrit Plugins

There is a newer version: 3.10.1

// Copyright (C) 2018 The Android Open Source Project
//
// 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.google.gerrit.entities;

import static com.google.common.base.Preconditions.checkState;

import com.google.auto.value.AutoValue;
import com.google.common.base.CharMatcher;

/** Describes a submit record requirement. Contains the requirement name and a description. */
@AutoValue
@AutoValue.CopyAnnotations
public abstract class LegacySubmitRequirement {
  private static final CharMatcher TYPE_MATCHER =
      CharMatcher.inRange('a', 'z')
          .or(CharMatcher.inRange('A', 'Z'))
          .or(CharMatcher.inRange('0', '9'))
          .or(CharMatcher.anyOf("-_"));

  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setType(String value);

    public abstract Builder setFallbackText(String value);

    public LegacySubmitRequirement build() {
      LegacySubmitRequirement requirement = autoBuild();
      checkState(
          validateType(requirement.type()),
          "LegacySubmitRequirement's type contains non alphanumerical symbols.");
      return requirement;
    }

    abstract LegacySubmitRequirement autoBuild();
  }

  /** Requirement description and explanation of what it does */
  public abstract String fallbackText();

  /** Requirement name */
  public abstract String type();

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

  private static boolean validateType(String type) {
    return TYPE_MATCHER.matchesAllOf(type);
  }
}