org.graylog2.contentpacks.model.entities.EntityDescriptor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation

Graylog

There is a newer version: 6.0.0

/**
 * This file is part of Graylog.
 *
 * Graylog 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 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog 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 Graylog.  If not, see .
 */
package org.graylog2.contentpacks.model.entities;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.auto.value.AutoValue;
import org.graylog2.contentpacks.model.Identified;
import org.graylog2.contentpacks.model.ModelId;
import org.graylog2.contentpacks.model.ModelType;
import org.graylog2.contentpacks.model.Typed;

/**
 * The unique description of a (virtual) entity by ID and type.
 */
@AutoValue
@JsonDeserialize(builder = AutoValue_EntityDescriptor.Builder.class)
public abstract class EntityDescriptor implements Identified, Typed {
    public static EntityDescriptor create(ModelId id, ModelType type) {
        return builder()
                .id(id)
                .type(type)
                .build();
    }

    /**
     * Shortcut for {@link #create(ModelId, ModelType)}
     */
    public static EntityDescriptor create(String id, ModelType type) {
        return create(ModelId.of(id), type);
    }

    public static Builder builder() {
        return new AutoValue_EntityDescriptor.Builder();
    }

    @AutoValue.Builder
    public interface Builder extends IdBuilder, TypeBuilder {
        EntityDescriptor build();
    }
}