// Copyright (C) 2012 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.common.data;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.entities.Project;

/** Portion of a {@link Project} describing a single contributor agreement. */
@AutoValue
public abstract class ContributorAgreement implements Comparable<ContributorAgreement> {
  public abstract String getName();

  @Nullable
  public abstract String getDescription();

  public abstract ImmutableList<PermissionRule> getAccepted();

  @Nullable
  public abstract GroupReference getAutoVerify();

  @Nullable
  public abstract String getAgreementUrl();

  public abstract ImmutableList<String> getExcludeProjectsRegexes();

  public abstract ImmutableList<String> getMatchProjectsRegexes();

  public static ContributorAgreement.Builder builder(String name) {
    return new AutoValue_ContributorAgreement.Builder()
        .setName(name)
        .setAccepted(ImmutableList.of())
        .setExcludeProjectsRegexes(ImmutableList.of())
        .setMatchProjectsRegexes(ImmutableList.of());
  }

  @Override
  public final int compareTo(ContributorAgreement o) {
    return getName().compareTo(o.getName());
  }

  @Override
  public final String toString() {
    return "ContributorAgreement[" + getName() + "]";
  }

  public abstract Builder toBuilder();

  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder setName(String name);

    public abstract Builder setDescription(@Nullable String description);

    public abstract Builder setAccepted(ImmutableList<PermissionRule> accepted);

    public abstract Builder setAutoVerify(@Nullable GroupReference autoVerify);

    public abstract Builder setAgreementUrl(@Nullable String agreementUrl);

    public abstract Builder setExcludeProjectsRegexes(ImmutableList<String> excludeProjectsRegexes);

    public abstract Builder setMatchProjectsRegexes(ImmutableList<String> matchProjectsRegexes);

    public abstract ContributorAgreement build();
  }
}