Remorhaz\Lexer\Runtime\Token\Token

Complexity

Total Complexity

7

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	createEoi()	0	6	1
A	getId()	0	3	1
A	isFinal()	0	3	1
A	getOffset()	0	3	1
A	getAttributes()	0	3	1
A	__construct()	0	10	1
A	getLexeme()	0	3	1

<?php

declare(strict_types=1);

namespace Remorhaz\Lexer\Runtime\Token;

use Remorhaz\Lexer\Runtime\IO\LexemeInterface;

/**
 * @psalm-immutable
 */
final class Token implements TokenInterface
{

    /**
     * @var int
     */
    private $id;

    /**
     * @var int
     */
    private $offset;

    /**
     * @var LexemeInterface
     */
    private $lexeme;

    /**
     * @var AttributeCollectionInterface
     */
    private $attributes;

    /**
     * @param int                               $offset
     * @param LexemeInterface                   $lexeme
     * @param AttributeCollectionInterface|null $attributes
     * @return TokenInterface
     */
    public static function createEoi(
        int $offset,
        LexemeInterface $lexeme,
        ?AttributeCollectionInterface $attributes = null
    ): TokenInterface {
        return new self(TokenInterface::ID_EOI, $offset, $lexeme, $attributes ?? new AttributeCollection());
    }

    /**
     * Token constructor.
     *
     * @param int                               $id
     * @param int                               $offset
     * @param LexemeInterface                   $lexeme
     * @param AttributeCollectionInterface|null $attributes
     */
    public function __construct(
        int $id,
        int $offset,
        LexemeInterface $lexeme,
        ?AttributeCollectionInterface $attributes = null
    ) {
        $this->id = $id;
        $this->offset = $offset;
        $this->lexeme = $lexeme;
        $this->attributes = $attributes ?? new AttributeCollection();
    }

    /**
     * @return int
     * @psalm-pure
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * @return int
     * @psalm-pure
     */
    public function getOffset(): int
    {
        return $this->offset;
    }

    /**
     * @return LexemeInterface
     * @psalm-pure
     */
    public function getLexeme(): LexemeInterface
    {
        return $this->lexeme;
    }

    /**
     * @return AttributeCollectionInterface
     * @psalm-pure
     */
    public function getAttributes(): AttributeCollectionInterface
    {
        return $this->attributes;
    }

    /**
     * @return bool
     * @psalm-pure
     */
    public function isFinal(): bool
    {
        return self::ID_EOI == $this->id;
    }
}