ILoreMetaParser.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.jcwhatever.nucleus.utils.items.loremeta;

import javax.annotation.Nullable;

/**
 * Parses and generates item lore meta.
 */
public interface ILoreMetaParser {

    /**
     * Determine if a line of lore text is meta.
     *
     * @param loreLine  The lore line to inspect.
     */
    boolean isLoreMeta(String loreLine);

    /**
     * Parse a line of lore meta text into a {@link LoreMetaItem} instance.
     *
     * @param loreLine  The lore line to parse.
     *
     * @return  The meta item or null if the lore line is not meta.
     */
    @Nullable
    LoreMetaItem parseLoreMeta(String loreLine);

    /**
     * Generate lore line text from a {@link LoreMetaItem} instance.
     *
     * @param item  The meta item.
     */
    String getMetaDisplay(LoreMetaItem item);

    /**
     * Generate lore line text from meta name and value.
     *
     * @param name   The name of the meta.
     * @param value  The meta value. Cannot be null but can be empty.
     */
    String getMetaDisplay(String name, String value);
}