Entry.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.settings;
 
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Entry {
 
    @NotNull
    private String value;
 
    @Nullable
    private String documentation;
 
    public Entry(@NotNull final String value, @Nullable final String documentation) {
        this.value = value;
        this.documentation = documentation;
    }
 
    @NotNull
    public String getValue() {
        return value;
    }
 
    public void setValue(@NotNull final String value) {
        this.value = value;
    }
 
    @Nullable
    public String getDocumentation() {
        return documentation;
    }
 
    public boolean setDocumentation(@Nullable final String documentation) {
        if (documentation == null || documentation.equals(this.documentation)) {
            return false;
        }
 
        this.documentation = documentation;
        return true;
    }
 
}