1 // Copyright 2014 The Bazel Authors. All rights reserved. 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 package com.google.devtools.common.options; 15 16 /** 17 * A converter is a little helper object that can take a String and 18 * turn it into an instance of type T (the type parameter to the converter). 19 */ 20 public interface Converter<T> { 21 22 /** 23 * Convert a string into type T. 24 */ convert(String input)25 T convert(String input) throws OptionsParsingException; 26 27 /** 28 * The type description appears in usage messages. E.g.: "a string", 29 * "a path", etc. 30 */ getTypeDescription()31 String getTypeDescription(); 32 33 } 34