review.classdesign.jammy.core

Class Contest

java.lang.Object

review.classdesign.jammy.common.NamedObject

review.classdesign.jammy.core.Contest

All Implemented Interfaces:

java.io.Serializable

public final class Contest
extends NamedObject

POJO class that represents a Google Jam Contest. A Contest is represented by a name and a collection of Round.

Author:

fv

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEST_CLASS_NAME Class name of the element that contains contest data.
static java.lang.String	CONTEST_INDEX URL of the contest index page.
private java.util.List<Round>	rounds Round that belongs to this contest.
private static long	serialVersionUID Serialization index.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Contest(java.lang.String name, java.util.List<Round> rounds) Default constructor.

Method Summary

Modifier and Type	Method and Description
static java.util.List<Contest>	get() Static factory method that retrieves all contest available on Google Jam index page.
private static java.util.Optional<java.lang.String>	getName(org.jsoup.nodes.Element element) Static factory method that retrieves contest name from a given HTML contest element.
java.util.List<Round>	getRounds() Getter that returns a immutable view of the Round list.

Methods inherited from class review.classdesign.jammy.common.NamedObject

getName, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization index.

See Also:

Constant Field Values

CONTEST_INDEX

public static final java.lang.String CONTEST_INDEX

URL of the contest index page.

See Also:

Constant Field Values

CONTEST_CLASS_NAME

public static final java.lang.String CONTEST_CLASS_NAME

Class name of the element that contains contest data.

See Also:

Constant Field Values

rounds

private final java.util.List<Round> rounds

Round that belongs to this contest.

Constructor Detail

Contest

private Contest(java.lang.String name,
                java.util.List<Round> rounds)

Default constructor.

Parameters:

name - Name of this contest.

rounds - Round that belongs to this contest.

Method Detail

getRounds

public java.util.List<Round> getRounds()

Getter that returns a immutable view of the Round list.

Returns:

List of the round of this contest.

See Also:

Collections.unmodifiableList(List)

getName

private static java.util.Optional<java.lang.String> getName(org.jsoup.nodes.Element element)

Static factory method that retrieves contest name from a given HTML contest element.

Parameters:

element - JSoup element to retrieve title from.

Returns:

Optional reference of a contest title.

get

public static java.util.List<Contest> get()
                                   throws java.lang.Exception

Static factory method that retrieves all contest available on Google Jam index page.

Returns:

List of contest found.

Throws:

java.lang.Exception - If any error occurs while retrieving or parsing document.