/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.storageengine.api;

import org.neo4j.token.api.TokenHolder;
import org.neo4j.values.storable.Value;

/**
 * Abstraction pairing property key token id and property value. Can represent both defined and undefined
 * property values, distinguished by {@link #isDefined()}. Undefined property instances can be used for
 * passing property key id and signaling that it doesn't exist.
 */
public interface StorageProperty {
    /**
     * @return property key token id for this property.
     */
    int propertyKeyId();

    /**
     * @return the property value or Values.NO_VALUE is this property does not exist.
     */
    Value value();

    /**
     * @return whether or not the property is defined, e.g. if it exists (has a value) or not.
     */
    boolean isDefined();

    String toString(TokenHolder tokenHolder);
}
