Package com.github.dozermapper.core.metadata

Interface MappingMetadata

  • All Known Implementing Classes:
    DozerMappingMetadata
    public interface MappingMetadata
    This interface can be used to query mapping metadata from the dozer internal data structures. It provides read only access to all important aspects of the mapping information on class and field level.

    • Method Detail

      • getClassMappings

        List<ClassMappingMetadata> getClassMappings()
        Obtains a list of all available mapping definitions.
        Returns:
        A list of ClassMappingMetadata

      • getClassMappingsBySourceName

        List<ClassMappingMetadata> getClassMappingsBySourceName​(String sourceClassName)
        This method retrieves class mapping metadata based on the source class name.
        Parameters:
        sourceClassName - The fully qualified class name of the source class.
        Returns:
        A list of mapping metadata which defines how to map a class with the name sourceClassName to other classes.

      • getClassMappingsByDestinationName

        List<ClassMappingMetadata> getClassMappingsByDestinationName​(String destinationClassName)
        This method retrieves class mapping metadata based on the destination class name.
        Parameters:
        destinationClassName - The fully qualified class name of the destination class.
        Returns:
        A list of mapping metadata which defines how to map to a class with the name destinationClassName.

      • getClassMappingByName

        ClassMappingMetadata getClassMappingByName​(String sourceClassName,
                                           String destinationClassName)
        This method retrieves class mapping metadata based on the class names.
        Parameters:
        sourceClassName - The fully qualified class name of the source class.
        destinationClassName - The fully qualified class name of the destination class.
        Returns:
        A list of mapping metadata which defines how to map a class with the name sourceClassName to a class with the name destinationClassName.

      • getClassMappingsBySource

        List<ClassMappingMetadata> getClassMappingsBySource​(Class<?> sourceClass)
        This method retrieves class mapping metadata based on the source class.
        Parameters:
        sourceClass - The Class object which references the source class.
        Returns:
        A list of mapping metadata which defines how to map the class sourceClass to other classes.

      • getClassMappingsByDestination

        List<ClassMappingMetadata> getClassMappingsByDestination​(Class<?> destinationClass)
        This method retrieves class mapping metadata based on the destination class.
        Parameters:
        destinationClass - The Class object which references the destination class.
        Returns:
        A list of mapping metadata which defines how to map to the class destinationClass.

      • getClassMapping

        ClassMappingMetadata getClassMapping​(Class<?> sourceClass,
                                     Class<?> destinationClass)
        This method retrieves class mapping metadata based on two Class objects.
        Parameters:
        sourceClass - The Class object that references the source class.
        destinationClass - The Class object that references the destination class.
        Returns:
        The mapping metadata object which defines how to map the class sourceClass to the class destinationClass.
        Throws:
        MetadataLookupException - If no class map could be found.