com.googlecode.blaisemath.encode.StringDecoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of blaise-common Show documentation

Common utilities shared across Blaise projects.

There is a newer version: 1.0.10

package com.googlecode.blaisemath.encode;

/*-
 * #%L
 * blaise-common
 * --
 * Copyright (C) 2014 - 2019 Elisha Peterson
 * --
 * 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.
 * #L%
 */

import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Converts an object from a string if possible. Decoders may or may not handle 
 * null/empty strings, and may or may not return null values.
 * Implementations should use {@link Nullable} annotations to indicate how they handle nulls.
 * 
 * @param  type of object to converter
 * @author Elisha Peterson
 */
public interface StringDecoder {
    
    /**
     * Decode object from a string.
     * @param str string to decode
     * @return decoded value
     * @throws IllegalArgumentException if the argument is invalid
     */
    X decode(String str); 
    
}