com.helger.commons.microdom.convert

Interface IMicroTypeConverter

All Known Implementing Classes:

MultilingualTextMicroTypeConverterRegistrar.MultiLingualTextConverter, MultilingualTextMicroTypeConverterRegistrar.ReadOnlyMultilingualTextConverter, StringBasedMicroTypeConverter, StringMicroTypeConverter

public interface IMicroTypeConverter

Interface to be implemented to marshal between IMicroElement and a native object.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
IMicroElement	convertToMicroElement(Object aObject, String sNamespaceURI, String sTagName) Convert the passed object to a micro element using the specified tag name
Object	convertToNative(IMicroElement aElement) Convert the passed object to a native element.

Method Detail

convertToMicroElement

@Nullable
IMicroElement convertToMicroElement(@Nonnull
                                           Object aObject,
                                           @Nullable
                                           String sNamespaceURI,
                                           @Nonnull@Nonempty
                                           String sTagName)

Convert the passed object to a micro element using the specified tag name

Parameters:

aObject - The object to be converted. May not be null.

sNamespaceURI - The namespace URI for the element to be created. May be null.

sTagName - The tag name to be used. May neither be null nor empty.

Returns:

null in case creation failed. A micro element with the specified namespace and tag name otherwise.

convertToNative

@Nullable
Object convertToNative(@Nonnull
                              IMicroElement aElement)

Convert the passed object to a native element.

Parameters:

aElement - The micro element to be converted.

Returns:

null if conversion to a native object failed.