Add metadata parameters to CreateLrpTokensCommand

As part of this change, built out a KeyValueMapParameter from the existing TransitionListParameter in order to enable other Map types in commands (two of which are used in CreateLrpTokensCommand).

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=137476564
This commit is contained in:
ctingue 2016-10-27 21:16:37 -07:00 committed by Ben McIlwain
parent 1dbc5f6bb0
commit c89a902b72
6 changed files with 326 additions and 52 deletions

View file

@ -0,0 +1,96 @@
// Copyright 2016 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.tools.params;
import com.google.common.base.Splitter;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
/**
* Combined converter and validator class for key-value map JCommander argument strings.
*
* <p>These strings have the form {@code <K-str>=<V-str>,[<K-str>=<V-str>]*} where
* {@code <K-str>} and {@code <V-str>} are strings that can be parsed into instances of some key
* type {@code K} and value type {@code V}, respectively. This class converts a string into an
* ImmutableMap mapping {@code K} to {@code V}. Validation and conversion share the same logic;
* validation is just done by attempting conversion and throwing exceptions if need be.
*
* <p>Subclasses must implement parseKey() and parseValue() to define how to parse {@code <K-str>}
* and {@code <V-str>} into {@code K} and {@code V}, respectively.
*
* @param <K> instance key type
* @param <V> instance value type
*/
public abstract class KeyValueMapParameter<K, V>
extends ParameterConverterValidator<ImmutableMap<K, V>> {
public KeyValueMapParameter(String messageForInvalid) {
super(messageForInvalid);
}
public KeyValueMapParameter() {
super("Not formatted correctly.");
}
/** Override to define how to parse rawKey into an object of type K. */
protected abstract K parseKey(String rawKey);
/** Override to define how to parse rawValue into an object of type V. */
protected abstract V parseValue(String rawValue);
/** Override to perform any post-processing on the map. */
protected ImmutableMap<K, V> processMap(ImmutableMap<K, V> map) {
return map;
}
@Override
public final ImmutableMap<K, V> convert(String keyValueMapString) {
ImmutableMap.Builder<K, V> builder = new ImmutableMap.Builder<>();
if (!Strings.isNullOrEmpty(keyValueMapString)) {
for (Map.Entry<String, String> entry :
Splitter.on(',').withKeyValueSeparator('=').split(keyValueMapString).entrySet()) {
builder.put(parseKey(entry.getKey()), parseValue(entry.getValue()));
}
}
return processMap(builder.build());
}
/** Combined converter and validator class for string-to-string Map argument strings. */
public static class StringToStringMap extends KeyValueMapParameter<String, String> {
@Override
protected String parseKey(String rawKey) {
return rawKey;
}
@Override
protected String parseValue(String value) {
return value;
}
}
/** Combined converter and validator class for string-to-integer Map argument strings. */
public static class StringToIntegerMap extends KeyValueMapParameter<String, Integer> {
@Override
protected String parseKey(String rawKey) {
return rawKey;
}
@Override
protected Integer parseValue(String value) {
return Integer.parseInt(value);
}
}
}

View file

@ -16,33 +16,16 @@ package google.registry.tools.params;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSortedMap;
import com.google.common.collect.Ordering;
import google.registry.model.registry.Registry.TldState;
import java.util.Map;
import org.joda.money.Money;
import org.joda.time.DateTime;
/**
* Combined converter and validator class for transition list JCommander argument strings.
*
* <p>These strings have the form {@code <DateTime>=<T-str>,[<DateTime>=<T-str>]*} where
* {@code <T-str>} is a string that can be parsed into an instance of some value type {@code T}, and
* the entire argument represents a series of timed transitions of some property taking on those
* values. This class converts such a string into an ImmutableSortedMap mapping DateTime to
* {@code T}. Validation and conversion share the same logic; validation is just done by attempting
* conversion and throwing exceptions if need be.
*
* <p>Subclasses must implement parseValue() to define how to parse {@code <T-str>} into a
* {@code T}.
*
* @param <T> instance value type
*/
/** Combined converter and validator class for transition list JCommander argument strings. */
// TODO(b/19031334): Investigate making this complex generic type work with the factory.
public abstract class TransitionListParameter<T>
extends ParameterConverterValidator<ImmutableSortedMap<DateTime, T>> {
public abstract class TransitionListParameter<V> extends KeyValueMapParameter<DateTime, V> {
private static final DateTimeParameter DATE_TIME_CONVERTER = new DateTimeParameter();
@ -50,24 +33,17 @@ public abstract class TransitionListParameter<T>
super("Not formatted correctly or has transition times out of order.");
}
/** Override to define how to parse rawValue into an object of type T. */
protected abstract T parseValue(String rawValue);
@Override
public ImmutableSortedMap<DateTime, T> convert(String transitionListString) {
ImmutableMap.Builder<DateTime, T> builder = new ImmutableMap.Builder<>();
for (Map.Entry<String, String> entry :
Splitter.on(',').withKeyValueSeparator('=').split(transitionListString).entrySet()) {
builder.put(
DATE_TIME_CONVERTER.convert(entry.getKey()),
parseValue(entry.getValue()));
}
ImmutableMap<DateTime, T> transitionMap = builder.build();
checkArgument(Ordering.natural().isOrdered(transitionMap.keySet()),
"Transition times out of order.");
return ImmutableSortedMap.copyOf(transitionMap);
protected final DateTime parseKey(String rawKey) {
return DATE_TIME_CONVERTER.convert(rawKey);
}
@Override
protected final ImmutableSortedMap<DateTime, V> processMap(ImmutableMap<DateTime, V> map) {
checkArgument(Ordering.natural().isOrdered(map.keySet()), "Transition times out of order.");
return ImmutableSortedMap.copyOf(map);
}
/** Converter-validator for TLD state transitions. */
public static class TldStateTransitions extends TransitionListParameter<TldState> {
@Override