Interface IObject

  • All Known Implementing Classes:
    ClassImpl, NoOpTestClass

    public interface IObject
    Represents the associations of a class with one or more instances. Relevant with @Factory annotation.
    • Method Detail

      • getObjects

        IObject.IdentifiableObject[] getObjects​(boolean create,
                                                java.lang.String errorMsgPrefix)
        Returns all the instances the methods will be invoked upon. This will typically be an array of one object in the absence of a @Factory annotation.
        Parameters:
        create - - true if objects should be created before returning.
        errorMsgPrefix - - Text that should be prefixed to the error message when there are issues. Can be empty.
        Returns:
        - An array of IObject.IdentifiableObject objects
      • getInstanceHashCodes

        long[] getInstanceHashCodes()
        Returns:
        - An array representing the hash codes of the corresponding instances.
      • addObject

        void addObject​(IObject.IdentifiableObject instance)
        Parameters:
        instance - - The instance that should be added to the list of instances.
      • instanceHashCodes

        static long[] instanceHashCodes​(java.lang.Object object)
        Parameters:
        object - - The object that should be inspected for its compatibility with IObject.
        Returns:
        - An array representing the hash codes of the corresponding instances.
      • objects

        static IObject.IdentifiableObject[] objects​(java.lang.Object object,
                                                    boolean create)
        Parameters:
        object - - The object that should be inspected for its compatibility with IObject.
        create - - true if objects should be created before returning.
        Returns:
        - An array (can be empty is instance compatibility fails) of IObject.IdentifiableObject objects.
      • objects

        static IObject.IdentifiableObject[] objects​(java.lang.Object object,
                                                    boolean create,
                                                    java.lang.String errorMsgPrefix)
        Parameters:
        object - - The object that should be inspected for its compatibility with IObject.
        create - - true if objects should be created before returning.
        errorMsgPrefix - - Text that should be prefixed to the error message when there are issues. Can be empty.
        Returns:
        - An array (can be empty is instance compatibility fails) of IObject.IdentifiableObject objects.
      • cast

        static java.util.Optional<IObject> cast​(java.lang.Object object)
        Parameters:
        object - - The object that should be inspected for its compatibility with IObject.
        Returns:
        - If the incoming object is an instance of IObject then the cast instance is wrapped within Optional else it would be an Optional.empty()