Package com.dropbox.core.v2.fileproperties

Class PropertyFieldTemplate

java.lang.Object

com.dropbox.core.v2.fileproperties.PropertyFieldTemplate

public class PropertyFieldTemplate
extends Object

Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	description
protected final String	name
protected final PropertyType	type

Constructor Summary

Constructors

Constructor	Description
PropertyFieldTemplate(String name, String description, PropertyType type)	Defines how a single property field may be structured.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Description of the property field.
String	getName()	Key of the property field being described.
PropertyType	getType()
int	hashCode()
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

@Nonnull
protected final String name

description

@Nonnull
protected final String description

type

@Nonnull
protected final PropertyType type

Constructor Details

PropertyFieldTemplate

public PropertyFieldTemplate(@Nonnull
 String name,
 @Nonnull
 String description,
 @Nonnull
 PropertyType type)

Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.

Parameters:

name - Key of the property field being described. Property field keys can be up to 256 bytes. Must not be null.

description - Description of the property field. Property field descriptions can be up to 1024 bytes. Must not be null.

type - Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getName

@Nonnull
public String getName()

Key of the property field being described. Property field keys can be up to 256 bytes.

Returns:

value for this field, never null.

getDescription

@Nonnull
public String getDescription()

Description of the property field. Property field descriptions can be up to 1024 bytes.

Returns:

value for this field, never null.

getType

@Nonnull
public PropertyType getType()

Returns:

value for this field, never null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object