Package org.assertj.core.internal

Class TypeMessages

java.lang.Object
org.assertj.core.internal.TypeMessages
public class TypeMessages extends Object
An internal holder of the custom message for type. It is used to store messages for registered classes. When looking for a message for a given class the holder returns the most relevant comparator.

  • Field Details

  • Constructor Details

    • TypeMessages

      public TypeMessages()

  • Method Details

    • getMessageForType

      public String getMessageForType(Class<?> clazz)
      This method returns the most relevant error message for the given class. The most relevant message is the message which is registered for the class that is closest in the inheritance chain of the given clazz. The order of checks is the following: 1. If there is a registered message for clazz then this one is used 2. We check if there is a registered message for a superclass of clazz 3. We check if there is a registered message for an interface of clazz
      Parameters:
      clazz - the class for which to find an error message
      Returns:
      the most relevant error message, or null if no message could be found

    • hasMessageForType

      public boolean hasMessageForType(Class<?> type)
      Checks, whether an any custom error message is associated with the giving type.
      Parameters:
      type - the type for which to check a error message
      Returns:
      is the giving type associated with any custom error message

    • registerMessage

      public <T> void registerMessage(Class<T> clazz, String message)
      Puts the message for the given clazz.
      Type Parameters:
      T - the type of the objects to associate with the message for
      Parameters:
      clazz - the class for the error message
      message - the error message itself

    • messageByTypes

      public Stream<Map.Entry<Class<?>,String>> messageByTypes()
      Returns a sequence of all type-message pairs which the current holder supplies.
      Returns:
      sequence of field-message pairs

    • get

      public String get(Class<?> clazz)
      This method returns the most relevant entity for the given class. The most relevant entity is the entity which is registered for the class that is closest in the inheritance chain of the given clazz. The order of checks is the following: 1. If there is a registered entity for clazz then this one is used 2. We check if there is a registered entity for a superclass of clazz 3. We check if there is a registered entity for an interface of clazz
      Parameters:
      clazz - the class for which to find a entity
      Returns:
      the most relevant entity, or null if on entity could be found

    • put

      public void put(Class<?> clazz, String entity)
      Puts the entity for the given clazz.
      Parameters:
      clazz - the class for the comparator
      entity - the entity itself

    • hasEntity

      public boolean hasEntity(Class<?> type)
      Checks, whether an entity is associated with the giving type.
      Parameters:
      type - the type for which to check an entity
      Returns:
      is the giving type associated with any entity

    • isEmpty

      public boolean isEmpty()
      Returns:
      true is there are registered entities, false otherwise

    • clear

      public void clear()
      Removes all registered entities.

    • entityByTypes

      public Stream<Map.Entry<Class<?>,String>> entityByTypes()
      Returns a sequence of all type-entity pairs which the current holder supplies.
      Returns:
      sequence of field-entity pairs

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object