DMDirc-Client/api/src/main/java/com/dmdirc/Topic.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * 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.dmdirc;

import com.dmdirc.interfaces.GroupChatUser;

import com.google.auto.value.AutoValue;

import java.time.LocalDateTime;
import java.util.Optional;

/**
 * Stores information about a channel topic.
 */
@AutoValue
public abstract class Topic {

    Topic() {}

    /** Topic. */
    public abstract String getTopic();
    /** Topic client. */
    public abstract Optional<GroupChatUser> getClient();
    /** Topic time. */
    public abstract LocalDateTime getDate();

    public static Topic create(final String topic,
            final GroupChatUser groupChatUser,
            final LocalDateTime date) {
        return new AutoValue_Topic(topic, Optional.ofNullable(groupChatUser), date);
    }
}