1 /** 2 * Copyright (C) 2010 the original author or authors. 3 * See the notice.md file distributed with this work for additional 4 * information regarding copyright ownership. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 package com.beust.jcommander; 20 21 /** 22 * An interface that converts strings to any arbitrary type. 23 * 24 * If your class implements a constructor that takes a String, this 25 * constructor will be used to instantiate your converter and the 26 * parameter will receive the name of the option that's being parsed, 27 * which can be useful to issue a more useful error message if the 28 * conversion fails. 29 * 30 * You can also extend BaseConverter to make your life easier. 31 * 32 * @author cbeust 33 */ 34 public interface IStringConverter<T> { 35 /** 36 * @return an object of type <T> created from the parameter value. 37 */ 38 T convert(String value); 39 } 40
