com.dropbox.core.v2.fileproperties

Class PropertyFieldTemplate

java.lang.Object

com.dropbox.core.v2.fileproperties.PropertyFieldTemplate

public class PropertyFieldTemplate
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected java.lang.String	name
protected PropertyType	type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Description of the property field.
java.lang.String	getName() Key of the property field being described.
PropertyType	getType() Data type of the value of this property field.
int	hashCode()
java.lang.String	toString()
java.lang.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 Detail

name

protected final java.lang.String name

description

protected final java.lang.String description

type

protected final PropertyType type

Constructor Detail

PropertyFieldTemplate

public PropertyFieldTemplate(java.lang.String name,
                             java.lang.String description,
                             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 - Data type of the value of this property field. This type will be enforced upon property creation and modifications. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getName

public java.lang.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

public java.lang.String getDescription()

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

Returns:

value for this field, never null.

getType

public PropertyType getType()

Data type of the value of this property field. This type will be enforced upon property creation and modifications.

Returns:

value for this field, never null.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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