Class Mapper

    • Constructor Summary

      Constructors 
      Constructor Description
      Mapper​(java.lang.String simpleName)  
    • Method Summary

      Modifier and Type Method Description
      abstract Mapper merge​(Mapper mergeWith, boolean updateAllTypes)
      Return the merge of mergeWith into this.
      abstract java.lang.String name()
      Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
      java.lang.String simpleName()
      Returns the simple name, which identifies this mapper against other mappers at the same level in the mappers hierarchy TODO: make this protected once Mapper and FieldMapper are merged together
      abstract java.lang.String typeName()
      Returns a name representing the the type of this mapper.
      abstract Mapper updateFieldType​(java.util.Map<java.lang.String,​MappedFieldType> fullNameToFieldType)
      Update the field type of this mapper.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, iterator, spliterator
    • Constructor Detail

      • Mapper

        public Mapper​(java.lang.String simpleName)
    • Method Detail

      • simpleName

        public final java.lang.String simpleName()
        Returns the simple name, which identifies this mapper against other mappers at the same level in the mappers hierarchy TODO: make this protected once Mapper and FieldMapper are merged together
      • name

        public abstract java.lang.String name()
        Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
      • typeName

        public abstract java.lang.String typeName()
        Returns a name representing the the type of this mapper.
      • merge

        public abstract Mapper merge​(Mapper mergeWith,
                                     boolean updateAllTypes)
        Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.
      • updateFieldType

        public abstract Mapper updateFieldType​(java.util.Map<java.lang.String,​MappedFieldType> fullNameToFieldType)
        Update the field type of this mapper. This is necessary because some mapping updates can modify mappings across several types. This method must return a copy of the mapper so that the current mapper is not modified.