org.apache.camel.spi.TypeConverterRegistry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.camel.spi;
import java.util.List;
import org.apache.camel.LoggingLevel;
import org.apache.camel.StaticService;
import org.apache.camel.TypeConverter;
import org.apache.camel.TypeConverterExists;
import org.apache.camel.TypeConverters;
/**
* Registry for type converters.
*
* The utilization {@link Statistics} is by default disabled, as it has a slight performance impact under very high
* concurrent load. The statistics can be enabled using {@link Statistics#setStatisticsEnabled(boolean)} method.
*
* @version
*/
public interface TypeConverterRegistry extends StaticService {
/**
* Utilization statistics of the this registry.
*/
interface Statistics {
/**
* Number of noop attempts (no type conversion was needed)
*/
long getNoopCounter();
/**
* Number of type conversion attempts
*/
long getAttemptCounter();
/**
* Number of successful conversions
*/
long getHitCounter();
/**
* Number of successful conversions by optimised core converters
*/
long getBaseHitCounter();
/**
* Number of attempts which cannot be converted as no suitable type converter exists
*/
long getMissCounter();
/**
* Number of failed attempts during type conversion
*/
long getFailedCounter();
/**
* Reset the counters
*/
void reset();
/**
* Whether statistics is enabled.
*/
boolean isStatisticsEnabled();
/**
* Sets whether statistics is enabled.
*
* @param statisticsEnabled true to enable
*/
void setStatisticsEnabled(boolean statisticsEnabled);
}
/**
* Registers a new type converter.
*
* This method may throw {@link org.apache.camel.TypeConverterExistsException} if configured to fail if an existing
* type converter already exists
*
* @param toType the type to convert to
* @param fromType the type to convert from
* @param typeConverter the type converter to use
*/
void addTypeConverter(Class toType, Class fromType, TypeConverter typeConverter);
/**
* Removes the type converter
*
* @param toType the type to convert to
* @param fromType the type to convert from
* @return true if removed, false if the type converter didn't exist
*/
boolean removeTypeConverter(Class toType, Class fromType);
/**
* Registers all the type converters from the class, each converter must be implemented as a method and annotated with {@link org.apache.camel.Converter}.
*
* @param typeConverters class which implements the type converters
*/
void addTypeConverters(TypeConverters typeConverters);
/**
* Registers a new fallback type converter
*
* @param typeConverter the type converter to use
* @param canPromote whether or not the fallback type converter can be promoted to a first class type converter
*/
void addFallbackTypeConverter(TypeConverter typeConverter, boolean canPromote);
/**
* Performs a lookup for a given type converter.
*
* @param toType the type to convert to
* @param fromType the type to convert from
* @return the type converter or null if not found.
*/
TypeConverter lookup(Class toType, Class fromType);
/**
* Gets a read-only list of the type converter from / to classes
*
* @return a list containing fromType/toType class names
*/
List[]> listAllTypeConvertersFromTo();
/**
* Sets the injector to be used for creating new instances during type conversions.
*
* @param injector the injector
*/
void setInjector(Injector injector);
/**
* Gets the injector
*
* @return the injector
*/
Injector getInjector();
/**
* Gets the utilization statistics of this type converter registry
*
* @return the utilization statistics
*/
Statistics getStatistics();
/**
* Number of type converters in the registry.
*
* @return number of type converters in the registry.
*/
int size();
/**
* The logging level to use when logging that a type converter already exists when attempting to add a duplicate type converter.
*
* The default logging level is WARN
*/
LoggingLevel getTypeConverterExistsLoggingLevel();
/**
* The logging level to use when logging that a type converter already exists when attempting to add a duplicate type converter.
*
* The default logging level is WARN
*/
void setTypeConverterExistsLoggingLevel(LoggingLevel typeConverterExistsLoggingLevel);
/**
* What should happen when attempting to add a duplicate type converter.
*
* The default behavior is to override the existing.
*/
TypeConverterExists getTypeConverterExists();
/**
* What should happen when attempting to add a duplicate type converter.
*
* The default behavior is to override the existing.
*/
void setTypeConverterExists(TypeConverterExists typeConverterExists);
}