com.codepulsar.nils.core.NilsConfig Maven / Gradle / Ivy
Show all versions of nils-core Show documentation
package com.codepulsar.nils.core;
import static com.codepulsar.nils.core.util.ParameterCheck.NILS_CONFIG;
import java.text.MessageFormat;
import java.time.format.FormatStyle;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import com.codepulsar.nils.core.adapter.AdapterConfig;
import com.codepulsar.nils.core.config.SuppressableErrorTypes;
import com.codepulsar.nils.core.error.ErrorType;
import com.codepulsar.nils.core.error.NilsConfigException;
import com.codepulsar.nils.core.handler.ClassPrefixResolver;
import com.codepulsar.nils.core.handler.TranslationFormatter;
import com.codepulsar.nils.core.util.ParameterCheck;
/** The configuration of the Nils library. */
public class NilsConfig {
private AdapterConfig adapterConfig;
private String escapePattern = "[{0}]";
private String includeTag = "@include";
private Set suppressErrors = Set.of(SuppressableErrorTypes.NONE);
private ClassPrefixResolver classPrefixResolver = ClassPrefixResolver.SIMPLE_CLASSNAME;
private TranslationFormatter translationFormatter = TranslationFormatter.MESSAGE_FORMAT;
private FormatStyle dateFormatStyle = FormatStyle.MEDIUM;
private NilsConfig(AdapterConfig adapterConfig) {
this.adapterConfig = adapterConfig;
}
/**
* Gets the {@link AdapterConfig} object.
*
* @return The {@link AdapterConfig} object.
*/
public AdapterConfig getAdapterConfig() {
return adapterConfig;
}
/**
* Gets the escape pattern if a translation is missing, but no exception should be thrown.
*
* The escape pattern must contain {0}.
*
* @return The pattern.
* @see #getSuppressErrors()
* @see #escapePattern(String)
*/
public String getEscapePattern() {
return escapePattern;
}
/**
* Sets the escape pattern if a translation is missing, but no exception should be thrown.
*
*
The escape pattern must contain {0}.
*
* @param escapePattern the pattern
* @return This config object.
* @see #getSuppressErrors()
* @see #getEscapePattern()
*/
public NilsConfig escapePattern(String escapePattern) {
ParameterCheck.notNullEmptyOrBlank(escapePattern, "escapePattern", NILS_CONFIG);
this.escapePattern = checkEscapePattern(escapePattern);
return this;
}
/**
* Gets the tag for include translations from other key.
*
*
The default value is @include.
*
* @return The tag used including translations.
* @see #includeTag(String)
*/
public String getIncludeTag() {
return includeTag;
}
/**
* Sets the tag for include translations from other key.
*
* @param includeTag The tag used including translations.
* @return This config object.
* @see #getIncludeTag()
*/
public NilsConfig includeTag(String includeTag) {
ParameterCheck.notNullEmptyOrBlank(includeTag, "includeTag", NILS_CONFIG);
this.includeTag = includeTag;
return this;
}
/**
* Gets the ErrorTypes that should be suppressed during the runtime.
*
* @return A Set of ErrorTypes.
* @see #suppressErrors(ErrorType, ErrorType...)
*/
public Set getSuppressErrors() {
return suppressErrors;
}
/**
* Sets the ErrorTypes that should be suppressed during the runtime.
*
* Note: The {@link ErrorType#ALL} and the {@link ErrorType#NONE} cannot be combined
* with other ErrorTypes and must be set exclusively.
*
* @param type A ErrorType.
* @param types Further ErrorTypes.
* @return This config object.
* @see #getSuppressErrors()
*/
public NilsConfig suppressErrors(ErrorType type, ErrorType... types) {
ParameterCheck.notNull(type, "type", NILS_CONFIG);
Set set = new HashSet<>();
set.add(type);
if (types != null && types.length > 0) {
set.addAll(Arrays.asList(types));
}
if (set.contains(ErrorType.NONE) && set.size() > 1) {
throw new NilsConfigException(
"Parameter 'type' is invalid: ErrorType.NONE cannot combined with other ErrorTypes.");
}
if (set.contains(ErrorType.ALL) && set.size() > 1) {
throw new NilsConfigException(
"Parameter 'type' is invalid: ErrorType.ALL cannot combined with other ErrorTypes.");
}
set.forEach(
c -> {
if (!c.isSuppressable()) {
throw new NilsConfigException(
"Parameter 'type' is invalid: ErrorType '"
+ c.getErrCode()
+ "' is not suppressable.");
}
});
suppressErrors = set;
return this;
}
/**
* Gets the {@link ClassPrefixResolver} object.
*
* The default is {@link ClassPrefixResolver#SIMPLE_CLASSNAME}.
*
* @return The {@link ClassPrefixResolver}.
* @see #classPrefixResolver(ClassPrefixResolver)
*/
public ClassPrefixResolver getClassPrefixResolver() {
return classPrefixResolver;
}
/**
* Sets the {@link ClassPrefixResolver} object.
*
* @param classPrefixResolver The {@link ClassPrefixResolver}.
* @return This config object.
* @see #getClassPrefixResolver()
*/
public NilsConfig classPrefixResolver(ClassPrefixResolver classPrefixResolver) {
ParameterCheck.notNull(classPrefixResolver, "classPrefixResolver", NILS_CONFIG);
this.classPrefixResolver = classPrefixResolver;
return this;
}
/**
* Gets the {@link TranslationFormatter} object.
*
*
The default is {@link TranslationFormatter#MESSAGE_FORMAT}.
*
* @return The {@link TranslationFormatter}.
* @see #translationFormatter(TranslationFormatter)
*/
public TranslationFormatter getTranslationFormatter() {
return translationFormatter;
}
/**
* Sets the {@link TranslationFormatter} object.
*
* @param translationFormatter The {@link TranslationFormatter}.
* @return This config object.
* @see #getTranslationFormatter()
*/
public NilsConfig translationFormatter(TranslationFormatter translationFormatter) {
ParameterCheck.notNull(translationFormatter, "translationFormatter", NILS_CONFIG);
this.translationFormatter = translationFormatter;
return this;
}
/**
* Gets the FormatStyle used in {@link Formats} objects, defining the style for date,
* time and date with time value.
*
*
The default is FormatStyle.MEDIUM.
*
* @return The FormatStyle.
* @see #dateFormatStyle(FormatStyle)
*/
public FormatStyle getDateFormatStyle() {
return dateFormatStyle;
}
/**
* Sets the FormatStyle used in {@link Formats} objects, defining the style for date,
* time and date with time value.
*
*
The default is FormatStyle.MEDIUM.
*
* @param dateFormatStyle The FormatStyle.
* @see #getDateFormatStyle()
* @see com.codepulsar.nils.core.Formats
*/
public NilsConfig dateFormatStyle(FormatStyle dateFormatStyle) {
ParameterCheck.notNull(dateFormatStyle, "dateFormatStyle", NILS_CONFIG);
this.dateFormatStyle = dateFormatStyle;
return this;
}
private String checkEscapePattern(String pattern) {
if (!pattern.contains("{0}")) {
throw new NilsConfigException(
"Parameter 'escapePattern' is invalid: It must contain the string \"{0}\".");
}
if (pattern.contains("'{0}'")) {
throw new NilsConfigException(
"Parameter 'escapePattern' is invalid: It must contain the string \"{0}\".");
}
try {
MessageFormat.format(pattern, "TEST");
} catch (IllegalArgumentException ex) {
throw new NilsConfigException("Parameter 'escapePattern' is invalid: " + ex.getMessage());
}
return pattern;
}
/**
* Create a NilsConfig from an {@link AdapterConfig}.
*
* @param adapterConfig An {@link AdapterConfig} object.
* @return The created NilsConfig.
*/
public static NilsConfig init(AdapterConfig adapterConfig) {
ParameterCheck.notNull(adapterConfig, "adapterConfig", NILS_CONFIG);
return new NilsConfig(adapterConfig);
}
}