net.dv8tion.jda.api.utils.data.SerializableData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of JDA Show documentation

Java wrapper for the popular chat & VOIP service: Discord https://discord.com

There is a newer version: 5.1.0

/*
 * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.dv8tion.jda.api.utils.data;

import javax.annotation.Nonnull;

/**
 * Allows custom serialization for JSON payloads of an object.
 */
public interface SerializableData
{
    /**
     * Serialized {@link net.dv8tion.jda.api.utils.data.DataObject} for this object.
     *
     * @return {@link net.dv8tion.jda.api.utils.data.DataObject}
     */
    @Nonnull
    DataObject toData();
}