ColourList Class Reference

Public Member Functions
Color	Get (int numberOfItems)
	This method returns a single colour, at an index calculated using the number of colours needed, and the length of the colour arraylist. More...
boolean	Add (Color colour)
	This method adds a single colour onto the end of the ArrayList. More...
	ColourList (int numberOfItems, String colourScheme)
	This method is one of the two constructors, this one is used if a non-user defined colour scheme is needed. More...
	ColourList (ArrayList< Color > userColourList)
	This method is the second constructor, used if a user defined colour scheme is being used. More...
String	toString ()
	This method produces a string representation of the ArrayList<Color> More...

Static Public Member Functions
static void	main (String args[])
	This method is the main method, and is never called by the software, it is only here to test the ArrayList<Color> with test values. More...

Constructor & Destructor Documentation

ColourList.ColourList	(	int	numberOfItems,
		String	colourScheme
	)

This method is one of the two constructors, this one is used if a non-user defined colour scheme is needed.

Parameters

numberOfItems	is the number of colours needed
colourScheme	is the name of the colourScheme chosen

Here is the call graph for this function:

ColourList.ColourList

(

ArrayList< Color >

userColourList

)

This method is the second constructor, used if a user defined colour scheme is being used.

Parameters

userColourList

is the ArrayList<Color> created by the user

Member Function Documentation

boolean ColourList.Add

(

Color

colour

)

This method adds a single colour onto the end of the ArrayList.

Parameters

colour

is the generated Color to be added to the ArrayList

Returns

the boolean, corresponding to if the input colour is valid

Color ColourList.Get

(

int

numberOfItems

)

This method returns a single colour, at an index calculated using the number of colours needed, and the length of the colour arraylist.

Parameters

numberOfItems

is an int equal to the number of colours required

Returns

the colour at the specified index, calculated as described above

static void ColourList.main ( String  args[] )

static

This method is the main method, and is never called by the software, it is only here to test the ArrayList<Color> with test values.

Parameters

args	is the String array equal to each term entered after the program call in the command line

Here is the call graph for this function:

String ColourList.toString

(

)

This method produces a string representation of the ArrayList<Color>

Returns

the String representation of the ArrayList<Color>

---

The documentation for this class was generated from the following file:

• ColourList.java