de.saxsys.svgfx.core.path.commands

Class CommandFactory

java.lang.Object

de.saxsys.svgfx.core.path.commands.CommandFactory

public final class CommandFactory
extends Object

This class is responsible for creating instances of an PathCommand.

Author:

Xyanid on 09.04.2017.

Constructor Summary

Constructors

Constructor and Description
CommandFactory()

Method Summary

Modifier and Type	Method and Description
CloseCommand	createCloseCommand(char commandName, javafx.geometry.Point2D startPoint) Creates a new CloseCommand using the given data, which needs to contain the command name.
PathCommand	createCommandOrFail(Character delimiter, String data, javafx.geometry.Point2D absolutePathStartingPoint, javafx.geometry.Point2D absoluteCurrentPoint, PathCommand previousCommand) Creates a new PathCommand based on the given information.
CubicBezierCurveCommand	createCubicBezierCurveCommand(char commandName, String data) Creates a new BezierCurveCommand using the given data, which needs to contains three points.
HorizontalLineCommand	createHorizontalLineCommand(char commandName, String data) Creates a new LineCommand using the given data, which need to contain one numeric value which determines which position is moved to.
LineCommand	createLineCommand(char commandName, String data) Creates a new LineCommand using the given data, which needs to be two numeric values separated by whitespaces or one comma which determines which position is moved to.
MoveCommand	createMoveCommand(char commandName, String data) Creates a new LineCommand using the given data, which needs to be two numeric values separated by whitespaces or one comma which determines which position is moved to.
QuadraticBezierCurveCommand	createQuadraticBezierCurveCommand(char commandName, String data) Creates a new BezierCurveCommand using the given data, which needs to contains three points.
CubicBezierCurveCommand	createShortCubicBezierCurveCommand(char commandName, String data, javafx.geometry.Point2D absoluteCurrentPoint, PathCommand previousCommand) Creates a new BezierCurveCommand using the given data, which needs to contains three points.
QuadraticBezierCurveCommand	createShortQuadraticBezierCurveCommand(char commandName, String data, javafx.geometry.Point2D absoluteStartPoint, PathCommand previousCommand) Creates a new BezierCurveCommand using the given data, which needs to contains three points.
VerticalLineCommand	createVerticalLineCommand(char commandName, String data) Creates a new LineCommand using the given data, which need to contain one numeric value which determines which position is moved to.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandFactory

public CommandFactory()

Method Detail

createCommandOrFail

public PathCommand createCommandOrFail(Character delimiter,
                                       String data,
                                       javafx.geometry.Point2D absolutePathStartingPoint,
                                       javafx.geometry.Point2D absoluteCurrentPoint,
                                       PathCommand previousCommand)
                                throws PathException

Creates a new PathCommand based on the given information.

Parameters:

delimiter - the Character which determines the command.

data - the data present for the command.

absolutePathStartingPoint - the absolute start point of a path command.

absoluteCurrentPoint - the absolute end point of the previous command, which is also the starting position of the created comand.

previousCommand - the previous command.

Returns:

a new PathCommand.

Throws:

PathException - if any error occurs during the creation of a PathCommand.

createMoveCommand

public MoveCommand createMoveCommand(char commandName,
                                     String data)
                              throws PathException

Creates a new LineCommand using the given data, which needs to be two numeric values separated by whitespaces or one comma which determines which position is moved to.

Parameters:

commandName - the name of the command.

data - the data describing the command.

Returns:

a new LineCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.MOVE or the data does not contain two numeric values separated be whitespaces or one comma.

createLineCommand

public LineCommand createLineCommand(char commandName,
                                     String data)
                              throws PathException

Creates a new LineCommand using the given data, which needs to be two numeric values separated by whitespaces or one comma which determines which position is moved to.

Parameters:

commandName - the name of the command.

data - the data describing the command.

Returns:

a new LineCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.LINE or the data does not contain two numeric values separated be whitespaces or one comma.

createHorizontalLineCommand

public HorizontalLineCommand createHorizontalLineCommand(char commandName,
                                                         String data)
                                                  throws PathException

Creates a new LineCommand using the given data, which need to contain one numeric value which determines which position is moved to.

Parameters:

commandName - the name of the command.

data - the data describing the command.

Returns:

a new LineCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.HORIZONTAL_LINE or if the given data is not a number.

createVerticalLineCommand

public VerticalLineCommand createVerticalLineCommand(char commandName,
                                                     String data)
                                              throws PathException

Creates a new LineCommand using the given data, which need to contain one numeric value which determines which position is moved to.

Parameters:

commandName - the name of the command.

data - the data describing the command.

Returns:

a new LineCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.VERTICAL_LINE or the given data is not a number.

createCloseCommand

public CloseCommand createCloseCommand(char commandName,
                                       javafx.geometry.Point2D startPoint)
                                throws PathException

Creates a new CloseCommand using the given data, which needs to contain the command name.

Parameters:

commandName - the name of the command.

startPoint - the start position which this command will travel to.

Returns:

a new CloseCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.CLOSE.

createCubicBezierCurveCommand

public CubicBezierCurveCommand createCubicBezierCurveCommand(char commandName,
                                                             String data)
                                                      throws PathException

Creates a new BezierCurveCommand using the given data, which needs to contains three points.

Parameters:

commandName - the name of the command.

data - the three points describing the curve.

Returns:

a new BezierCurveCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.CUBIC_BEZIER_CURVE or the data does not represent three points.

createShortCubicBezierCurveCommand

public CubicBezierCurveCommand createShortCubicBezierCurveCommand(char commandName,
                                                                  String data,
                                                                  javafx.geometry.Point2D absoluteCurrentPoint,
                                                                  PathCommand previousCommand)
                                                           throws PathException

Creates a new BezierCurveCommand using the given data, which needs to contains three points.

Parameters:

commandName - the name of the command.

data - the three points describing the curve.

absoluteCurrentPoint - the position of the start of the previous command, which is needed to determine the start position of the created command.

previousCommand - the previous PathCommand which needs to be a BezierCurveCommand.

Returns:

a new BezierCurveCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.SHORT_CUBIC_BEZIER_CURVE or the data does not represent three points.

createQuadraticBezierCurveCommand

public QuadraticBezierCurveCommand createQuadraticBezierCurveCommand(char commandName,
                                                                     String data)
                                                              throws PathException

Creates a new BezierCurveCommand using the given data, which needs to contains three points.

Parameters:

commandName - the name of the command.

data - the three points describing the curve.

Returns:

a new BezierCurveCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.CUBIC_BEZIER_CURVE or the data does not represent 2 points.

createShortQuadraticBezierCurveCommand

public QuadraticBezierCurveCommand createShortQuadraticBezierCurveCommand(char commandName,
                                                                          String data,
                                                                          javafx.geometry.Point2D absoluteStartPoint,
                                                                          PathCommand previousCommand)
                                                                   throws PathException

Creates a new BezierCurveCommand using the given data, which needs to contains three points.

Parameters:

commandName - the name of the command.

data - the three points describing the curve.

absoluteStartPoint - the position of the start of the previous command, which is needed to determine the start position of the created command.

previousCommand - the previous PathCommand which needs to be a BezierCurveCommand.

Returns:

a new BezierCurveCommand.

Throws:

PathException - if the commandName is not absolute or relative CommandName.SHORT_CUBIC_BEZIER_CURVE or the given command is not a BezierCurveCommand or the data does not represent a point.