com.cedarsoftware.util.convert.ConverterOptions Maven / Gradle / Ivy
package com.cedarsoftware.util.convert;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
/**
* @author Kenny Partlow ([email protected])
*
* Copyright (c) Cedar Software LLC
*
* 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
*
* License
*
* 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.
*/
public interface ConverterOptions {
/**
* @return {@link ZoneId} to use for source conversion when one is not provided and is required on the target
* type. ie. {@link LocalDateTime}, {@link LocalDate}, or {@link String} when no zone is provided.
*/
default ZoneId getZoneId() { return ZoneId.systemDefault(); }
/**
* @return Locale to use as target when converting between types that require a Locale.
*/
default Locale getLocale() { return Locale.getDefault(); }
/**
* @return Charset to use os target Charset on types that require a Charset during conversion (if required).
*/
default Charset getCharset() { return StandardCharsets.UTF_8; }
/**
* @return Classloader for loading and initializing classes.
*/
default ClassLoader getClassLoader() { return ConverterOptions.class.getClassLoader(); }
/**
* @return custom option
*/
default T getCustomOption(String name) { return null; }
/**
* @return TimeZone expected on the target when finished (only for types that support ZoneId or TimeZone)
*/
default TimeZone getTimeZone() { return TimeZone.getTimeZone(this.getZoneId()); }
/**
* Character to return for boolean to Character conversion when the boolean is true.
* @return the Character representing true
*/
default Character trueChar() { return CommonValues.CHARACTER_ONE; }
/**
* Character to return for boolean to Character conversion when the boolean is false.
* @return the Character representing false
*/
default Character falseChar() { return CommonValues.CHARACTER_ZERO; }
/**
* Overrides for converter conversions.
* @return The Map of overrides.
*/
default Map, Class>, Convert> getConverterOverrides() { return new HashMap<>(); }
}