Package dev.zemco.codegame.presentation.solution.errors

Class ImmutableSolutionErrorModel

java.lang.Object

dev.zemco.codegame.presentation.solution.errors.ImmutableSolutionErrorModel

All Implemented Interfaces:

ISolutionErrorModel

public class ImmutableSolutionErrorModel
extends Object
implements ISolutionErrorModel

Immutable implementation holding details about an error in user's solution to a problem.

Author:

Erik Zemčík

Constructor Summary

Constructors

Constructor	Description
ImmutableSolutionErrorModel(String description, Integer linePosition)	Creates an instance of ImmutableSolutionErrorModel holding the given description and linePosition.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the error.
Optional<Integer>	getLinePosition()	Returns the zero-based line position within the solution code associated with the error.

Methods inherited from class java.lang.Object

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

Constructor Details

ImmutableSolutionErrorModel

public ImmutableSolutionErrorModel(String description,
 Integer linePosition)

Creates an instance of ImmutableSolutionErrorModel holding the given description and linePosition.

Parameters:

description - description of the error

linePosition - zero-based line position associated with the error, may be null

Throws:

IllegalArgumentException - if description is null or if linePosition is not null and is not a positive integer

Method Details

getDescription

public String getDescription()

Description copied from interface: ISolutionErrorModel

Returns the description of the error.

Specified by:

getDescription in interface ISolutionErrorModel

Returns:

description of the error

getLinePosition

public Optional<Integer> getLinePosition()

Description copied from interface: ISolutionErrorModel

Returns the zero-based line position within the solution code associated with the error. This method may return an empty optional when no line position is available.

Specified by:

getLinePosition in interface ISolutionErrorModel

Returns:

zero-based line position