PojoClass (openpojo 0.9.0 API)

All Superinterfaces:

Accessible, Annotatable, PojoElement

All Known Implementing Classes:

PojoClassImpl
```
public interface PojoClass
extends PojoElement, Accessible
```
This Interface defines the contract published by PojoClass implementations. The idea is to give an easy and flexible way to work with application POJO classes.

Author:

oshoukry

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`copy(Object from, Object to)` Copy all contents from one Instance represented by this PojoClass to another.
`boolean`	`extendz(Class<?> type)` Checks to see if class extends/implements a certain type.
`Class<?>`	`getClazz()` This method returns the underlying class represented by this instance.
`PojoClass`	`getEnclosingClass()` If this is a nested class, get enclosing class.
`List<PojoClass>`	`getInterfaces()` Returns a list of all interfaces implemented by the class represented by this PojoClass.
`PojoPackage`	`getPackage()` Get Enclosing Package
`List<PojoMethod>`	`getPojoConstructors()` Get all Constructors defined in the class.
`List<PojoField>`	`getPojoFields()` Get all PojoFields defined in the class.
`List<PojoField>`	`getPojoFieldsAnnotatedWith(Class<? extends Annotation> annotation)` Get all PojoFields annotated with given annotation.
`List<PojoMethod>`	`getPojoMethods()` Get all PojoMethods defined in the class;
`List<PojoMethod>`	`getPojoMethodsAnnotatedWith(Class<? extends Annotation> annotation)` Get all PojoMethods annotated with given annotation
`String`	`getSourcePath()` This method returns the location from which this class was loaded.
`PojoClass`	`getSuperClass()` Return the super class of the class represented by this PojoClass class.
`boolean`	`isAbstract()` Check if PojoClass wraps an abstract.
`boolean`	`isArray()` Check if PojoClass wraps an array.
`boolean`	`isConcrete()` Check if PojoClass wraps a concrete (i.e.
`boolean`	`isEnum()` Check if PojoClass wraps an enum.
`boolean`	`isFinal()` Check if PojoClass wraps a final class.
`boolean`	`isInterface()` Check if PojoClass wraps an interface.
`boolean`	`isNestedClass()` Checks to see if this class is a nested subclass.
`boolean`	`isStatic()` Check if PojoClass wraps a static class.
`boolean`	`isSynthetic()`
`String`	`toString(Object instance)` This method converts a pojoClass instance's contents to a string.

Methods inherited from interface com.openpojo.reflection.PojoElement
getName

Methods inherited from interface com.openpojo.reflection.Annotatable
getAnnotation, getAnnotations

Methods inherited from interface com.openpojo.reflection.Accessible
isPackagePrivate, isPrivate, isProtected, isPublic

- Method Detail
  - isInterface
```
boolean isInterface()
```
    Check if PojoClass wraps an interface.
    
    Returns:
    
    true if this PojoClass wraps an interface.
  - isAbstract
```
boolean isAbstract()
```
    Check if PojoClass wraps an abstract.
    
    Returns:
    
    true if this PojoClass wraps an abstract class.
  - isConcrete
```
boolean isConcrete()
```
    Check if PojoClass wraps a concrete (i.e. can be instantiated).
    
    Returns:
    
    true if this PojoClass wraps a concrete class.
  - isEnum
```
boolean isEnum()
```
    Check if PojoClass wraps an enum.
    
    Returns:
    
    true if this PojoClass wraps an enum type.
  - isArray
```
boolean isArray()
```
    Check if PojoClass wraps an array.
    
    Returns:
    
    true if this PojoClass wraps an array class.
  - isFinal
```
boolean isFinal()
```
    Check if PojoClass wraps a final class.
    
    Returns:
    
    true if this PojoClass wraps a final class.
  - isSynthetic
```
boolean isSynthetic()
```
    Returns:
    
    true if this PojoField is synthetic (i.e. jdk compiler generated).
  - getPojoFields
```
List<PojoField> getPojoFields()
```
    Get all PojoFields defined in the class.
    
    Returns:
    
    the pojoFields
  - getPojoFieldsAnnotatedWith
```
List<PojoField> getPojoFieldsAnnotatedWith(Class<? extends Annotation> annotation)
```
    Get all PojoFields annotated with given annotation.
    
    Parameters:
    
    annotation - the annotation to use for lookup.
    
    Returns:
    
    the list of fields that are annotated with given annotation.
  - getPojoMethods
```
List<PojoMethod> getPojoMethods()
```
    Get all PojoMethods defined in the class;
    
    Returns:
    
    the list of all methods defined in class, this includes constructors and synthetically added methods by the compiler.
  - getPojoMethodsAnnotatedWith
```
List<PojoMethod> getPojoMethodsAnnotatedWith(Class<? extends Annotation> annotation)
```
    Get all PojoMethods annotated with given annotation
    
    Parameters:
    
    annotation - the annotation to use for lookup.
    
    Returns:
    
    a list of methods that are annotated with given annotation.
  - getPojoConstructors
```
List<PojoMethod> getPojoConstructors()
```
    Get all Constructors defined in the class.
    
    Returns:
    
    the list of constructors.
  - getEnclosingClass
```
PojoClass getEnclosingClass()
```
    If this is a nested class, get enclosing class.
    
    Returns:
    
    the enclosing class' PojoClass, or null.
  - extendz
```
boolean extendz(Class<?> type)
```
    Checks to see if class extends/implements a certain type.
    
    Parameters:
    
    type - The type in question.
    
    Returns:
    
    True if class is subclass or implements an interface, otherwise false.
  - getSuperClass
```
PojoClass getSuperClass()
```
    Return the super class of the class represented by this PojoClass class.
    
    Returns:
    
    PojoClass representing the super class of this class or null if none exist.
  - getInterfaces
```
List<PojoClass> getInterfaces()
```
    Returns a list of all interfaces implemented by the class represented by this PojoClass.
    
    Returns:
    
    The list of interfaces implemented by the class wrapped by this PojoClass.
  - getPackage
```
PojoPackage getPackage()
```
    Get Enclosing Package
    
    Returns:
    
    the package that has this class is part of.
  - getClazz
```
Class<?> getClazz()
```
    This method returns the underlying class represented by this instance.
    
    Returns:
    
    The class type wrapped by this PojoClass.
  - isNestedClass
```
boolean isNestedClass()
```
    Checks to see if this class is a nested subclass.
    
    Returns:
    
    True if it is a subclass, false otherwise.
  - isStatic
```
boolean isStatic()
```
    Check if PojoClass wraps a static class. This would be true for example when a class is defined as nested and is declared static.
    
    Returns:
    
    true if this PojoClass wraps a static class.
  - copy
```
void copy(Object from,
          Object to)
```
    Copy all contents from one Instance represented by this PojoClass to another.
    
    Parameters:
    
    from - The Instance to copy from.
    
    to - The Instance to copy to.
  - toString
```
String toString(Object instance)
```
    This method converts a pojoClass instance's contents to a string. This method can serve as a good delegate for all toString().
    
    Parameters:
    
    instance - The instance to print the contents out of.
    
    Returns:
    
    String representation of the instance.
  - getSourcePath
```
String getSourcePath()
```
    This method returns the location from which this class was loaded. Note: Do not use, still in experimental mode.
    
    Returns:
    
    String of the PATH of where this class was loaded from.

Interface PojoClass

Method Summary

Methods inherited from interface com.openpojo.reflection.PojoElement

Methods inherited from interface com.openpojo.reflection.Annotatable

Methods inherited from interface com.openpojo.reflection.Accessible

Method Detail

isInterface

isAbstract

isConcrete

isEnum

isArray

isFinal

isSynthetic

getPojoFields

getPojoFieldsAnnotatedWith

getPojoMethods

getPojoMethodsAnnotatedWith

getPojoConstructors

getEnclosingClass

extendz

getSuperClass

getInterfaces

getPackage

getClazz

isNestedClass

isStatic

copy

toString

getSourcePath