InheritanceProvider.ClassInfo (bombe 0.3.0 API)

All Known Implementing Classes:

InheritanceProvider.ClassInfo.Abstract, InheritanceProvider.ClassInfo.Impl

Enclosing interface:

InheritanceProvider
```
public static interface InheritanceProvider.ClassInfo
```
A wrapper used to store inheritance information about classes.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InheritanceProvider.ClassInfo.Abstract` Abstract base implementation for `InheritanceProvider.ClassInfo` that provides a standard implementation of `InheritanceProvider.ClassInfo.Abstract.equals(Object)`, `InheritanceProvider.ClassInfo.Abstract.hashCode()` and `InheritanceProvider.ClassInfo.Abstract.toString()`.
`static class`	`InheritanceProvider.ClassInfo.Impl` A default, simple implementation of `InheritanceProvider.ClassInfo`.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`canInherit(InheritanceProvider.ClassInfo child, FieldSignature field)` Returns whether the given child class could inherit the given field from this parent class.
`default boolean`	`canInherit(InheritanceProvider.ClassInfo child, MethodSignature method)` Returns whether the given child class could inherit the given method from this parent class.
`default InheritanceType`	`getField(FieldSignature field)` Returns the `InheritanceType` of a field declared in this class that matches the given `FieldSignature`.
`Map<FieldSignature,InheritanceType>`	`getFields()` Gets an unmodifiable view of all fields declared in the class.
`Map<String,InheritanceType>`	`getFieldsByName()` Gets an unmodifiable view of all field names declared in the class.
`List<String>`	`getInterfaces()` Gets an unmodifiable view of all the direct interfaces of the class.
`default InheritanceType`	`getMethod(MethodSignature method)` Returns the `InheritanceType` of a method declared in this class that matches the given `MethodSignature`.
`Map<MethodSignature,InheritanceType>`	`getMethods()` Gets an unmodifiable view of all methods declared in the class.
`String`	`getName()` Gets the name of the class.
`default String`	`getPackage()` Gets the package name of the class.
`String`	`getSuperName()` Gets the name of this class' super class.
`default boolean`	`hasParent(InheritanceProvider.ClassInfo info, InheritanceProvider provider)` Returns whether this class has another class as a parent.
`default boolean`	`hasParent(String klass, InheritanceProvider provider)` Returns whether this class has another class as a parent.
`boolean`	`isInterface()` Gets whether the represented class is an interface.
`default InheritanceProvider.ClassInfo`	`lazy()` Returns a new `InheritanceProvider.ClassInfo` that caches the information returned by the getters in this interface.
`default boolean`	`overrides(MethodSignature method, InheritanceProvider.ClassInfo parent)` Returns whether this class overrides the specified method in the given parent class.
`default Set<InheritanceProvider.ClassInfo>`	`provideParents(InheritanceProvider provider)` Gets an unmodifiable view of all parents of this class, recursively.
`default void`	`provideParents(InheritanceProvider provider, Collection<InheritanceProvider.ClassInfo> parents)` Populates the given collection with all parents of this class, recursively.

- Method Detail
  - getName
```
String getName()
```
    Gets the name of the class.
    
    Returns:
    
    The class' name
  - getPackage
```
default String getPackage()
```
    Gets the package name of the class.
    
    Returns:
    
    The package name
    
    Since:
    
    0.3.0
  - isInterface
```
boolean isInterface()
```
    Gets whether the represented class is an interface.
    
    Returns:
    
    true if the class is an interface
    
    Since:
    
    0.3.0
  - getSuperName
```
String getSuperName()
```
    Gets the name of this class' super class.
    Returns an empty string for interfaces or Object.
    
    Returns:
    
    The super name
  - getInterfaces
```
List<String> getInterfaces()
```
    Gets an unmodifiable view of all the direct interfaces of the class.
    
    Returns:
    
    The class' interfaces
  - getFields
```
Map<FieldSignature,InheritanceType> getFields()
```
    Gets an unmodifiable view of all fields declared in the class. It does not include fields inherited from parent classes.
    
    Returns:
    
    The declared fields
    
    Since:
    
    0.3.0
  - getFieldsByName
```
Map<String,InheritanceType> getFieldsByName()
```
    Gets an unmodifiable view of all field names declared in the class. It does not include fields inherited from parent classes.
    
    Returns:
    
    The declared field names
    
    Since:
    
    0.3.0
  - getMethods
```
Map<MethodSignature,InheritanceType> getMethods()
```
    Gets an unmodifiable view of all methods declared in the class. It does not include methods inherited from parent classes.
    
    Returns:
    
    The declared methods
    
    Since:
    
    0.3.0
  - provideParents
```
default Set<InheritanceProvider.ClassInfo> provideParents(InheritanceProvider provider)
```
    Gets an unmodifiable view of all parents of this class, recursively.
    If a class in the inheritance chain cannot be provided by the given InheritanceProvider it will be missing in the result, along with all its parent classes.
    
    Parameters:
    
    provider - The provider to use for looking up parent classes
    
    Returns:
    
    A set with all parents of the class (recursively)
    
    Since:
    
    0.3.0
  - provideParents
```
default void provideParents(InheritanceProvider provider,
                            Collection<InheritanceProvider.ClassInfo> parents)
```
    Populates the given collection with all parents of this class, recursively.
    If a class in the inheritance chain cannot be provided by the given InheritanceProvider it will be missing in the result, along with all its parent classes.
    
    Parameters:
    
    provider - The provider to use for looking up parent classes
    
    parents - The collection to populate
    
    Since:
    
    0.3.0
  - hasParent
```
default boolean hasParent(String klass,
                          InheritanceProvider provider)
```
    Returns whether this class has another class as a parent.
    This method may return unexpected results if a class in the inheritance chain cannot be provided by the given InheritanceProvider.
    
    Parameters:
    
    klass - The class to search in the parents of this class
    
    provider - The provider to use for looking up parent classes
    
    Returns:
    
    true if this class inherits from the specified class
    
    Since:
    
    0.3.0
  - hasParent
```
default boolean hasParent(InheritanceProvider.ClassInfo info,
                          InheritanceProvider provider)
```
    Returns whether this class has another class as a parent.
    This method may return unexpected results if a class in the inheritance chain cannot be provided by the given InheritanceProvider.
    
    Parameters:
    
    info - The class to search in the parents of this class
    
    provider - The provider to use for looking up parent classes
    
    Returns:
    
    true if this class inherits from the specified class
    
    Since:
    
    0.3.0
  - getField
```
default InheritanceType getField(FieldSignature field)
```
    Returns the InheritanceType of a field declared in this class that matches the given FieldSignature.
    
    Parameters:
    
    field - The field signature
    
    Returns:
    
    The inheritance type or InheritanceType.NONE
    
    Since:
    
    0.3.0
  - getMethod
```
default InheritanceType getMethod(MethodSignature method)
```
    Returns the InheritanceType of a method declared in this class that matches the given MethodSignature.
    
    Parameters:
    
    method - The method signature
    
    Returns:
    
    The inheritance type or InheritanceType.NONE
    
    Since:
    
    0.3.0
  - canInherit
```
default boolean canInherit(InheritanceProvider.ClassInfo child,
                           FieldSignature field)
```
    Returns whether the given child class could inherit the given field from this parent class.
    Note: This method does not check if the given class actually extends this class or interface. Use #hasParent(ClassInfo, InheritanceProvider) to check this additionally if necessary.
    
    Parameters:
    
    child - The child class to check
    
    field - The field to check
    
    Returns:
    
    true if the child class could inherit the method
    
    Since:
    
    0.3.0
  - canInherit
```
default boolean canInherit(InheritanceProvider.ClassInfo child,
                           MethodSignature method)
```
    Returns whether the given child class could inherit the given method from this parent class.
    Note: This method does not check if the given class actually extends this class or interface. Use #hasParent(ClassInfo, InheritanceProvider) to check this additionally if necessary.
    
    Parameters:
    
    child - The child class to check
    
    method - The method to check
    
    Returns:
    
    true if the child class could inherit the method
    
    Since:
    
    0.3.0
  - overrides
```
default boolean overrides(MethodSignature method,
                          InheritanceProvider.ClassInfo parent)
```
    Returns whether this class overrides the specified method in the given parent class.
    Note: This method does not check if the given class actually extends this class or interface. Use #hasParent(ClassInfo, InheritanceProvider) to check this additionally if necessary.
    
    Parameters:
    
    method - The method to check
    
    parent - The parent class to check
    
    Returns:
    
    true if this class overrides the method
    
    Since:
    
    0.3.0
  - lazy
```
default InheritanceProvider.ClassInfo lazy()
```
    Returns a new InheritanceProvider.ClassInfo that caches the information returned by the getters in this interface.
    This method is intended for usage by InheritanceProviders to simplify their implementation. All InheritanceProvider.ClassInfo provided by an InheritanceProvider should be lazy initialized or otherwise cached.
    
    Returns:
    
    A lazy class info
    
    Since:
    
    0.3.0

Interface InheritanceProvider.ClassInfo

Nested Class Summary

Method Summary

Method Detail

getName

getPackage

isInterface

getSuperName

getInterfaces

getFields

getFieldsByName

getMethods

provideParents

provideParents

hasParent

hasParent

getField

getMethod

canInherit

canInherit

overrides

lazy