sh.props.converters.Converter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of props-core Show documentation

Layered application property management library for Java

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2021 - 2021 Mihai Bojin
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

package sh.props.converters;

import sh.props.annotations.Nullable;

@FunctionalInterface
public interface Converter {

  /**
   * Decodes and decrypts the passed string value into its final type.
   *
   * @param value the value to decode
   * @return the value parsed as T
   */
  @Nullable
  T decode(@Nullable String value);

  /**
   * Encodes the value as a {@link String}.
   *
   * @param value the value to encode
   * @return the string representation of the passed value argument
   */
  @Nullable
  default String encode(@Nullable T value) {
    return value == null ? null : value.toString();
  }
}