Package com.evolveum.midpoint.model.api.visualizer.localization

Interface WrapableLocalization<T,C>

Type Parameters:
T - the type of the current wrapper object
C - the type of the context object with extra data about the individual localization parts.
All Superinterfaces:
Serializable
public interface WrapableLocalization<T,C> extends Serializable
Localization composed of multiple "parts", which can be "wrapped" to some other object. Clients of the interface may chain more "wrappings" with the wrap(com.evolveum.midpoint.model.api.visualizer.localization.LocalizationPartsWrapper<? super T, C, ? extends R>) method. When all the wrappings are set, the combineParts(Collector) or the combineParts(Object, LocalizationPartsCombiner) methods could be used to specify the combination function, which will "combine" all localization together after their translation. Implementations of this interface should implement all methods in a "lazy fashion". That means, the underlying "parts" should not be manipulated in any way. They should be only "prepared" for the actual "manipulation" (wrapping, combining), which may eventually happen upon the method calls on returned LocalizableObject.

  • Method Details

    • combineParts

      <R> LocalizableObject<R> combineParts(R accumulator, LocalizationPartsCombiner<? super T,R> combiner)
      Combine individual localization parts together to form a single localization object which can be translated. Combination of localization parts does not happen immediately after the method call, but it will eventually happen during manipulation with resulting LocalizableObject.
      Type Parameters:
      R - the type of the localization parts container.
      Parameters:
      accumulator - the mutable "container" which can hold individual localization parts. Depending on the combiner, it (the combiner) may or may not return the same instance.
      combiner - the mutable reduction function, which should combine previously combined parts with another part.
      Returns:
      the localization object, which contains results container with all accumulated localization parts.

    • combineParts

      <R> LocalizableObject<R> combineParts(Collector<? super T,?,R> collector)
      Combine individual localization parts together to form a single localization object which can be translated. Combination of localization parts does not happen immediately after the method call, but it will eventually happen during manipulation with resulting LocalizableObject. Main difference from the combineParts(Object, LocalizationPartsCombiner) is that thanks to the Collector's "finisher", the type of final result is not tight to the intermediate mutable container used to accumulate all the parts. This allows to e.g. use collector, which internally collects all parts (e.g. Strings) to a StringBuilder, but the final result will be String.
      Type Parameters:
      R - the type of the collecting result.
      Parameters:
      collector - the instance of Collector, which implement the desired mutable reduction function.
      Returns:
      the localization object, which contains the result of the collecting using the provided collector.

    • wrap

      <R> WrapableLocalization<R,C> wrap(LocalizationPartsWrapper<? super T,C,? extends R> wrapper)
      Wrap (potentially already wrapped) localization parts to another wrapper object. This method can be used to wrap localization parts to another "wrapper" objects using the supplied ". Supplied {@code wrapper) parameter is nothing else than a set of functions which wraps individual "types" of localization parts. There are several types of localization parts. The wrapper has to implement function to wrap each of the localization part, regardless of its actual presence. This is one of the unpleasant limitation of the API. @param wrapper the implementation of wrapping function of each possible localization part type. @return another instance of the {@code WrapableLocalization} with set wrapping functions. @param <R> the type of the wrapping object.

    • of

      @SafeVarargs static <C> WrapableLocalization<String,C> of(LocalizationPart<C>... parts)
      Convenient factory method to create new instance of the WrapableLocalization
      Type Parameters:
      C - the type of the context object with extra data about the individual localization parts.
      Parameters:
      parts - the individual localization parts.
      Returns:
      new instance of the WrapableLocalization