ClassModel (mongo-java-driver 3.5.0-alpha1 API)

java.lang.Object
- org.bson.codecs.pojo.ClassModel<T>

Type Parameters:

T - The type of the class the ClassModel represents
```
public final class ClassModel<T>
extends Object
```
This model represents the metadata for a class and all its fields.

Since:

3.5

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <S> ClassModelBuilder<S>`	`builder(Class<S> type)` Creates a new Class Model builder instance using reflection.
`boolean`	`equals(Object o)`
`String`	`getDiscriminator()` Returns the discriminator key.
`String`	`getDiscriminatorKey()` Gets the value for the discriminator.
`FieldModel<?>`	`getFieldModel(String documentFieldName)` Gets a field by the document field name.
`List<FieldModel<?>>`	`getFieldModels()` Returns all the fields on this model
`FieldModel<?>`	`getIdFieldModel()` Returns the `FieldModel` mapped as the id field for this ClassModel
`String`	`getName()` Returns the name of the class represented by this ClassModel
`Class<T>`	`getType()`
`int`	`hashCode()`
`boolean`	`hasTypeParameters()`
`String`	`toString()`
`boolean`	`useDiscriminator()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - builder
```
public static <S> ClassModelBuilder<S> builder(Class<S> type)
```
    Creates a new Class Model builder instance using reflection.
    
    Type Parameters:
    
    S - the type of the class
    
    Parameters:
    
    type - the POJO class to reflect and configure the builder with.
    
    Returns:
    
    a new Class Model builder instance using reflection on the clazz.
  - getType
```
public Class<T> getType()
```
    Returns:
    
    the backing class for the ClassModel
  - hasTypeParameters
```
public boolean hasTypeParameters()
```
    Returns:
    
    true if the underlying type has type parameters.
  - useDiscriminator
```
public boolean useDiscriminator()
```
    Returns:
    
    true if a discriminator should be used when storing the data.
  - getDiscriminatorKey
```
public String getDiscriminatorKey()
```
    Gets the value for the discriminator.
    
    Returns:
    
    the discriminator value or null if not set
  - getDiscriminator
```
public String getDiscriminator()
```
    Returns the discriminator key.
    
    Returns:
    
    the discriminator key or null if not set
  - getFieldModel
```
public FieldModel<?> getFieldModel(String documentFieldName)
```
    Gets a field by the document field name.
    
    Parameters:
    
    documentFieldName - the fieldModel's document name
    
    Returns:
    
    the field or null if the field is not found
  - getFieldModels
```
public List<FieldModel<?>> getFieldModels()
```
    Returns all the fields on this model
    
    Returns:
    
    the list of fields
  - getIdFieldModel
```
public FieldModel<?> getIdFieldModel()
```
    Returns the FieldModel mapped as the id field for this ClassModel
    
    Returns:
    
    the FieldModel for the id
  - getName
```
public String getName()
```
    Returns the name of the class represented by this ClassModel
    
    Returns:
    
    the name
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ClassModel<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

getType

hasTypeParameters

useDiscriminator

getDiscriminatorKey

getDiscriminator

getFieldModel

getFieldModels

getIdFieldModel

getName

toString

equals

hashCode