public class

Step

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.analytics.Step

Class Overview

Single step in a multistep goal.

Summary

Constants
String NAME XML "name" attribute name
String NUMBER XML "number" attribute name
String PATH XML "path" attribute name
String XML_NAME XML element name
Fields
private String name Step's name
private Integer number Step's number in sequence
private String path Step's path
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
Step()
Default mutable constructor.
Step(String name, Integer number, String path)
Immutable constructor.
Public Methods
boolean equals(Object obj)
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
String getName()
Returns the step's name.
Integer getNumber()
Returns the step's number in sequence.
String getPath()
Returns the step's path.
boolean hasName()
Returns whether it has the step's name.
boolean hasNumber()
Returns whether it has the step's number in sequence.
boolean hasPath()
Returns whether it has the step's path.
int hashCode()
void setName(String name)
Sets the step's name.
void setNumber(Integer number)
Sets the step's number in sequence.
void setPath(String path)
Sets the step's path.
String toString()
Protected Methods
void consumeAttributes(AttributeHelper helper)
Consumes attributes from the attribute helper.
void putAttributes(AttributeGenerator generator)
Puts attributes into the attribute generator.
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension

Constants

private static final String NAME

XML "name" attribute name

Constant Value: "name"

private static final String NUMBER

XML "number" attribute name

Constant Value: "number"

private static final String PATH

XML "path" attribute name

Constant Value: "path"

static final String XML_NAME

XML element name

Constant Value: "step"

Fields

private String name

Step's name

private Integer number

Step's number in sequence

private String path

Step's path

Public Constructors

public Step ()

Default mutable constructor.

public Step (String name, Integer number, String path)

Immutable constructor.

Parameters
name Step's name.
number Step's number in sequence.
path Step's path.

Public Methods

public boolean equals (Object obj)

Parameters
obj

public static ExtensionDescription getDefaultDescription (boolean required, boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters
required Whether it is required
repeatable Whether it is repeatable
Returns
  • extension description

public String getName ()

Returns the step's name.

Returns
  • step's name

public Integer getNumber ()

Returns the step's number in sequence.

Returns
  • step's number in sequence

public String getPath ()

Returns the step's path.

Returns
  • step's path

public boolean hasName ()

Returns whether it has the step's name.

Returns
  • whether it has the step's name

public boolean hasNumber ()

Returns whether it has the step's number in sequence.

Returns
  • whether it has the step's number in sequence

public boolean hasPath ()

Returns whether it has the step's path.

Returns
  • whether it has the step's path

public int hashCode ()

public void setName (String name)

Sets the step's name.

Parameters
name Step's name or null to reset

public void setNumber (Integer number)

Sets the step's number in sequence.

Parameters
number Step's number in sequence or null to reset

public void setPath (String path)

Sets the step's path.

Parameters
path Step's path or null to reset

public String toString ()

Protected Methods

protected void consumeAttributes (AttributeHelper helper)

Consumes attributes from the attribute helper. May also use consumeContent(boolean) to consume the element's text content. Called from getHandler(ExtensionProfile, String, String, Attributes). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
helper Attribute helper
Throws
ParseException

protected void putAttributes (AttributeGenerator generator)

Puts attributes into the attribute generator. Called from generate(XmlWriter, ExtensionProfile). Default implementation does nothing, though generally this is discouraged unless there really are no attributes.

Parameters
generator Attribute generator

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.