\hypertarget{classColourList}{\section{Colour\-List Class Reference}
\label{classColourList}\index{Colour\-List@{Colour\-List}}
}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
Color \hyperlink{classColourList_ac7df3b6f6f45a3dff5e957b594b68f70}{Get} (int number\-Of\-Items)
\begin{DoxyCompactList}\small\item\em This method returns a single colour, at an index calculated using the number of colours needed, and the length of the colour arraylist. \end{DoxyCompactList}\item 
boolean \hyperlink{classColourList_affe3a84f27f249b14c33bce9ef334aa4}{Add} (Color colour)
\begin{DoxyCompactList}\small\item\em This method adds a single colour onto the end of the Array\-List. \end{DoxyCompactList}\item 
\hyperlink{classColourList_a3d4c4a8d7eafbf94f988aaeb259fc001}{Colour\-List} (int number\-Of\-Items, String colour\-Scheme)
\begin{DoxyCompactList}\small\item\em This method is one of the two constructors, this one is used if a non-\/user defined colour scheme is needed. \end{DoxyCompactList}\item 
\hyperlink{classColourList_acf3a17d5504c80c25a2f0cbd57f775ef}{Colour\-List} (Array\-List$<$ Color $>$ user\-Colour\-List)
\begin{DoxyCompactList}\small\item\em This method is the second constructor, used if a user defined colour scheme is being used. \end{DoxyCompactList}\item 
String \hyperlink{classColourList_aeeac1305bbeefc12077ff28c3752441b}{to\-String} ()
\begin{DoxyCompactList}\small\item\em This method produces a string representation of the Array\-List$<$\-Color$>$ \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \hyperlink{classColourList_a91f9d52a10a505741802400d0e2e881d}{main} (String args\mbox{[}$\,$\mbox{]})
\begin{DoxyCompactList}\small\item\em This method is the main method, and is never called by the software, it is only here to test the Array\-List$<$\-Color$>$ with test values. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classColourList_a3d4c4a8d7eafbf94f988aaeb259fc001}{\index{Colour\-List@{Colour\-List}!Colour\-List@{Colour\-List}}
\index{Colour\-List@{Colour\-List}!ColourList@{Colour\-List}}
\subsubsection[{Colour\-List}]{\setlength{\rightskip}{0pt plus 5cm}Colour\-List.\-Colour\-List (
\begin{DoxyParamCaption}
\item[{int}]{number\-Of\-Items, }
\item[{String}]{colour\-Scheme}
\end{DoxyParamCaption}
)}}\label{classColourList_a3d4c4a8d7eafbf94f988aaeb259fc001}


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


\begin{DoxyParams}{Parameters}
{\em number\-Of\-Items} & is the number of colours needed \\
\hline
{\em colour\-Scheme} & is the name of the colour\-Scheme chosen \\
\hline
\end{DoxyParams}


Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classColourList_a3d4c4a8d7eafbf94f988aaeb259fc001_cgraph}
\end{center}
\end{figure}


\hypertarget{classColourList_acf3a17d5504c80c25a2f0cbd57f775ef}{\index{Colour\-List@{Colour\-List}!Colour\-List@{Colour\-List}}
\index{Colour\-List@{Colour\-List}!ColourList@{Colour\-List}}
\subsubsection[{Colour\-List}]{\setlength{\rightskip}{0pt plus 5cm}Colour\-List.\-Colour\-List (
\begin{DoxyParamCaption}
\item[{Array\-List$<$ Color $>$}]{user\-Colour\-List}
\end{DoxyParamCaption}
)}}\label{classColourList_acf3a17d5504c80c25a2f0cbd57f775ef}


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


\begin{DoxyParams}{Parameters}
{\em user\-Colour\-List} & is the Array\-List$<$\-Color$>$ created by the user \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classColourList_affe3a84f27f249b14c33bce9ef334aa4}{\index{Colour\-List@{Colour\-List}!Add@{Add}}
\index{Add@{Add}!ColourList@{Colour\-List}}
\subsubsection[{Add}]{\setlength{\rightskip}{0pt plus 5cm}boolean Colour\-List.\-Add (
\begin{DoxyParamCaption}
\item[{Color}]{colour}
\end{DoxyParamCaption}
)}}\label{classColourList_affe3a84f27f249b14c33bce9ef334aa4}


This method adds a single colour onto the end of the Array\-List. 


\begin{DoxyParams}{Parameters}
{\em colour} & is the generated Color to be added to the Array\-List\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the boolean, corresponding to if the input colour is valid 
\end{DoxyReturn}
\hypertarget{classColourList_ac7df3b6f6f45a3dff5e957b594b68f70}{\index{Colour\-List@{Colour\-List}!Get@{Get}}
\index{Get@{Get}!ColourList@{Colour\-List}}
\subsubsection[{Get}]{\setlength{\rightskip}{0pt plus 5cm}Color Colour\-List.\-Get (
\begin{DoxyParamCaption}
\item[{int}]{number\-Of\-Items}
\end{DoxyParamCaption}
)}}\label{classColourList_ac7df3b6f6f45a3dff5e957b594b68f70}


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


\begin{DoxyParams}{Parameters}
{\em number\-Of\-Items} & is an int equal to the number of colours required\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the colour at the specified index, calculated as described above 
\end{DoxyReturn}
\hypertarget{classColourList_a91f9d52a10a505741802400d0e2e881d}{\index{Colour\-List@{Colour\-List}!main@{main}}
\index{main@{main}!ColourList@{Colour\-List}}
\subsubsection[{main}]{\setlength{\rightskip}{0pt plus 5cm}static void Colour\-List.\-main (
\begin{DoxyParamCaption}
\item[{String}]{args\mbox{[}$\,$\mbox{]}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classColourList_a91f9d52a10a505741802400d0e2e881d}


This method is the main method, and is never called by the software, it is only here to test the Array\-List$<$\-Color$>$ with test values. 


\begin{DoxyParams}{Parameters}
{\em args} & is the String array equal to each term entered after the program call in the command line \\
\hline
\end{DoxyParams}


Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classColourList_a91f9d52a10a505741802400d0e2e881d_cgraph}
\end{center}
\end{figure}


\hypertarget{classColourList_aeeac1305bbeefc12077ff28c3752441b}{\index{Colour\-List@{Colour\-List}!to\-String@{to\-String}}
\index{to\-String@{to\-String}!ColourList@{Colour\-List}}
\subsubsection[{to\-String}]{\setlength{\rightskip}{0pt plus 5cm}String Colour\-List.\-to\-String (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classColourList_aeeac1305bbeefc12077ff28c3752441b}


This method produces a string representation of the Array\-List$<$\-Color$>$ 

\begin{DoxyReturn}{Returns}
the String representation of the Array\-List$<$\-Color$>$ 
\end{DoxyReturn}


The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
\hyperlink{ColourList_8java}{Colour\-List.\-java}\end{DoxyCompactItemize}