com.couchbase.client.java.repository.mapping

Interface PropertyMetadata

All Known Implementing Classes:

ReflectionBasedPropertyMetadata

public interface PropertyMetadata

Represents the metadata for a document property inside an EntityMetadata.

Since:

2.2.0

Author:

Michael Nitschinger

Method Summary

Modifier and Type	Method and Description
Object	get(Object source) Returns the content of the field property.
boolean	isField() If this property represents a field in the Document.
boolean	isId() If this property represents the Document ID.
String	name() The name of the field inside the document.
String	realName() The name of the actual property inside the java entity.
void	set(Object value, Object source) Sets the content of the field property.
Class<?>	type() The type of the field property.

Method Detail

isId

boolean isId()

If this property represents the Document ID.

Returns:

true if it does, false otherwise.

isField

boolean isField()

If this property represents a field in the Document.

Returns:

true if it does, false otherwise.

name

String name()

The name of the field inside the document.

If an alias is used, it is reflected in here. If the raw field name in the entity is needed, use realName().

Returns:

the name of the field.

realName

String realName()

The name of the actual property inside the java entity.

Returns:

the real field name.

get

Object get(Object source)

Returns the content of the field property.

Parameters:

source - the source object.

Returns:

the content of the field.

set

void set(Object value,
         Object source)

Sets the content of the field property.

Parameters:

value - the value to set.

source - the source object.

type

Class<?> type()

The type of the field property.

Returns:

the type.