com.google.gerrit.common.data.LabelType Maven / Gradle / Ivy
// Copyright (C) 2008 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 static java.util.Comparator.comparing;
import static java.util.stream.Collectors.collectingAndThen;
import static java.util.stream.Collectors.toList;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.reviewdb.client.LabelId;
import com.google.gerrit.reviewdb.client.PatchSetApproval;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class LabelType {
public static final boolean DEF_ALLOW_POST_SUBMIT = true;
public static final boolean DEF_CAN_OVERRIDE = true;
public static final boolean DEF_COPY_ALL_SCORES_IF_NO_CHANGE = true;
public static final boolean DEF_COPY_ALL_SCORES_IF_NO_CODE_CHANGE = false;
public static final boolean DEF_COPY_ALL_SCORES_ON_TRIVIAL_REBASE = false;
public static final boolean DEF_COPY_ALL_SCORES_ON_MERGE_FIRST_PARENT_UPDATE = false;
public static final boolean DEF_COPY_MAX_SCORE = false;
public static final boolean DEF_COPY_MIN_SCORE = false;
public static final boolean DEF_IGNORE_SELF_APPROVAL = false;
public static LabelType withDefaultValues(String name) {
checkName(name);
List values = new ArrayList<>(2);
values.add(new LabelValue((short) 0, "Rejected"));
values.add(new LabelValue((short) 1, "Approved"));
return new LabelType(name, values);
}
public static String checkName(String name) {
checkNameInternal(name);
if ("SUBM".equals(name)) {
throw new IllegalArgumentException("Reserved label name \"" + name + "\"");
}
return name;
}
public static String checkNameInternal(String name) {
if (name == null || name.isEmpty()) {
throw new IllegalArgumentException("Empty label name");
}
for (int i = 0; i < name.length(); i++) {
char c = name.charAt(i);
if ((i == 0 && c == '-')
|| !((c >= 'a' && c <= 'z')
|| (c >= 'A' && c <= 'Z')
|| (c >= '0' && c <= '9')
|| c == '-')) {
throw new IllegalArgumentException("Illegal label name \"" + name + "\"");
}
}
return name;
}
private static List sortValues(List values) {
values = new ArrayList<>(values);
if (values.isEmpty()) {
return Collections.emptyList();
}
values = values.stream().sorted(comparing(LabelValue::getValue)).collect(toList());
short v = values.get(0).getValue();
short i = 0;
ArrayList result = new ArrayList<>();
// Fill in any missing values with empty text.
while (i < values.size()) {
while (v < values.get(i).getValue()) {
result.add(new LabelValue(v++, ""));
}
v++;
result.add(values.get(i++));
}
result.trimToSize();
return Collections.unmodifiableList(result);
}
protected String name;
// String rather than LabelFunction for backwards compatibility with GWT JSON interface.
protected String functionName;
protected boolean copyMinScore;
protected boolean copyMaxScore;
protected boolean copyAllScoresOnMergeFirstParentUpdate;
protected boolean copyAllScoresOnTrivialRebase;
protected boolean copyAllScoresIfNoCodeChange;
protected boolean copyAllScoresIfNoChange;
protected boolean allowPostSubmit;
protected boolean ignoreSelfApproval;
protected short defaultValue;
protected List values;
protected short maxNegative;
protected short maxPositive;
private transient boolean canOverride;
private transient List refPatterns;
private transient Map byValue;
protected LabelType() {}
public LabelType(String name, List valueList) {
this.name = checkName(name);
canOverride = true;
values = sortValues(valueList);
defaultValue = 0;
functionName = LabelFunction.MAX_WITH_BLOCK.getFunctionName();
maxNegative = Short.MIN_VALUE;
maxPositive = Short.MAX_VALUE;
if (values.size() > 0) {
if (values.get(0).getValue() < 0) {
maxNegative = values.get(0).getValue();
}
if (values.get(values.size() - 1).getValue() > 0) {
maxPositive = values.get(values.size() - 1).getValue();
}
}
setCanOverride(DEF_CAN_OVERRIDE);
setCopyAllScoresIfNoChange(DEF_COPY_ALL_SCORES_IF_NO_CHANGE);
setCopyAllScoresIfNoCodeChange(DEF_COPY_ALL_SCORES_IF_NO_CODE_CHANGE);
setCopyAllScoresOnTrivialRebase(DEF_COPY_ALL_SCORES_ON_TRIVIAL_REBASE);
setCopyAllScoresOnMergeFirstParentUpdate(DEF_COPY_ALL_SCORES_ON_MERGE_FIRST_PARENT_UPDATE);
setCopyMaxScore(DEF_COPY_MAX_SCORE);
setCopyMinScore(DEF_COPY_MIN_SCORE);
setAllowPostSubmit(DEF_ALLOW_POST_SUBMIT);
setIgnoreSelfApproval(DEF_IGNORE_SELF_APPROVAL);
byValue = new HashMap<>();
for (LabelValue v : values) {
byValue.put(v.getValue(), v);
}
}
public String getName() {
return name;
}
public boolean matches(PatchSetApproval psa) {
return psa.getLabelId().get().equalsIgnoreCase(name);
}
public LabelFunction getFunction() {
if (functionName == null) {
return null;
}
return LabelFunction.parse(functionName)
.orElseThrow(() -> new IllegalStateException("Unsupported functionName: " + functionName));
}
public void setFunction(@Nullable LabelFunction function) {
this.functionName = function != null ? function.getFunctionName() : null;
}
public boolean canOverride() {
return canOverride;
}
public List getRefPatterns() {
return refPatterns;
}
public void setCanOverride(boolean canOverride) {
this.canOverride = canOverride;
}
public boolean allowPostSubmit() {
return allowPostSubmit;
}
public void setAllowPostSubmit(boolean allowPostSubmit) {
this.allowPostSubmit = allowPostSubmit;
}
public boolean ignoreSelfApproval() {
return ignoreSelfApproval;
}
public void setIgnoreSelfApproval(boolean ignoreSelfApproval) {
this.ignoreSelfApproval = ignoreSelfApproval;
}
public void setRefPatterns(List refPatterns) {
if (refPatterns != null) {
this.refPatterns =
refPatterns.stream().collect(collectingAndThen(toList(), Collections::unmodifiableList));
} else {
this.refPatterns = null;
}
}
public List getValues() {
return values;
}
public LabelValue getMin() {
if (values.isEmpty()) {
return null;
}
return values.get(0);
}
public LabelValue getMax() {
if (values.isEmpty()) {
return null;
}
return values.get(values.size() - 1);
}
public short getDefaultValue() {
return defaultValue;
}
public void setDefaultValue(short defaultValue) {
this.defaultValue = defaultValue;
}
public boolean isCopyMinScore() {
return copyMinScore;
}
public void setCopyMinScore(boolean copyMinScore) {
this.copyMinScore = copyMinScore;
}
public boolean isCopyMaxScore() {
return copyMaxScore;
}
public void setCopyMaxScore(boolean copyMaxScore) {
this.copyMaxScore = copyMaxScore;
}
public boolean isCopyAllScoresOnMergeFirstParentUpdate() {
return copyAllScoresOnMergeFirstParentUpdate;
}
public void setCopyAllScoresOnMergeFirstParentUpdate(
boolean copyAllScoresOnMergeFirstParentUpdate) {
this.copyAllScoresOnMergeFirstParentUpdate = copyAllScoresOnMergeFirstParentUpdate;
}
public boolean isCopyAllScoresOnTrivialRebase() {
return copyAllScoresOnTrivialRebase;
}
public void setCopyAllScoresOnTrivialRebase(boolean copyAllScoresOnTrivialRebase) {
this.copyAllScoresOnTrivialRebase = copyAllScoresOnTrivialRebase;
}
public boolean isCopyAllScoresIfNoCodeChange() {
return copyAllScoresIfNoCodeChange;
}
public void setCopyAllScoresIfNoCodeChange(boolean copyAllScoresIfNoCodeChange) {
this.copyAllScoresIfNoCodeChange = copyAllScoresIfNoCodeChange;
}
public boolean isCopyAllScoresIfNoChange() {
return copyAllScoresIfNoChange;
}
public void setCopyAllScoresIfNoChange(boolean copyAllScoresIfNoChange) {
this.copyAllScoresIfNoChange = copyAllScoresIfNoChange;
}
public boolean isMaxNegative(PatchSetApproval ca) {
return maxNegative == ca.getValue();
}
public boolean isMaxPositive(PatchSetApproval ca) {
return maxPositive == ca.getValue();
}
public LabelValue getValue(short value) {
return byValue.get(value);
}
public LabelValue getValue(PatchSetApproval ca) {
return byValue.get(ca.getValue());
}
public LabelId getLabelId() {
return new LabelId(name);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder(name).append('[');
LabelValue min = getMin();
LabelValue max = getMax();
if (min != null && max != null) {
sb.append(
new PermissionRange(Permission.forLabel(name), min.getValue(), max.getValue())
.toString()
.trim());
} else if (min != null) {
sb.append(min.formatValue().trim());
} else if (max != null) {
sb.append(max.formatValue().trim());
}
sb.append(']');
return sb.toString();
}
}