001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.plot.flag.types;
020
021import com.plotsquared.core.configuration.caption.Caption;
022import com.plotsquared.core.plot.flag.PlotFlag;
023import org.checkerframework.checker.nullness.qual.NonNull;
024
025/**
026 * Plot flag representing a string value.
027 * This should be used where strings are not "keys" themselves, e.g. when setting enums
028 */
029public abstract class StringFlag<F extends StringFlag<F>> extends PlotFlag<String, F> {
030
031    /**
032     * Construct a new flag instance.
033     *
034     * @param value           Flag value
035     * @param flagCategory    The flag category
036     * @param flagDescription A caption describing the flag functionality
037     */
038    protected StringFlag(
039            final @NonNull String value,
040            final @NonNull Caption flagCategory,
041            final @NonNull Caption flagDescription
042    ) {
043        super(value, flagCategory, flagDescription);
044    }
045
046    @Override
047    public boolean isValuedPermission() {
048        return false;
049    }
050
051}