com.enonic.xp.task.TaskDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation

core-api

There is a newer version: 7.14.4

package com.enonic.xp.task;

import java.util.Objects;

import com.google.common.base.Preconditions;

import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.descriptor.Descriptor;
import com.enonic.xp.form.Form;
import com.enonic.xp.page.DescriptorKey;

@PublicApi
public final class TaskDescriptor
    extends Descriptor
{
    private final String description;

    private final Form config;

    private TaskDescriptor( final Builder builder )
    {
        super( builder.key );
        this.description = builder.description;
        this.config = builder.config == null ? Form.create().build() : builder.config;
    }

    public String getDescription()
    {
        return description;
    }

    public Form getConfig()
    {
        return config;
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( o == null || getClass() != o.getClass() )
        {
            return false;
        }
        final TaskDescriptor that = (TaskDescriptor) o;
        return Objects.equals( description, that.description ) && Objects.equals( config, that.config );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( description, config );
    }

    public static Builder create()
    {
        return new Builder();
    }

    public static final class Builder
    {
        private DescriptorKey key;

        private String description;

        private Form config;

        private Builder()
        {
        }

        public Builder key( final DescriptorKey key )
        {
            this.key = key;
            return this;
        }

        public Builder description( final String description )
        {
            this.description = description;
            return this;
        }

        public Builder config( final Form config )
        {
            this.config = config;
            return this;
        }

        public TaskDescriptor build()
        {
            Preconditions.checkNotNull( this.key, "key cannot be null" );
            return new TaskDescriptor( this );
        }
    }
}