com.enonic.xp.task.TaskProgress 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
The newest version!
package com.enonic.xp.task;

import java.io.Serializable;
import java.util.Objects;

import com.google.common.base.MoreObjects;

import com.enonic.xp.annotation.PublicApi;

@PublicApi
public final class TaskProgress
    implements Serializable
{
    private static final long serialVersionUID = 0;

    public static final TaskProgress EMPTY = TaskProgress.create().build();

    private final int current;

    private final int total;

    private final String info;

    private TaskProgress( final Builder builder )
    {
        current = builder.current;
        total = builder.total;
        info = Objects.requireNonNullElse( builder.info, "" );
    }

    public int getCurrent()
    {
        return current;
    }

    public int getTotal()
    {
        return total;
    }

    public String getInfo()
    {
        return info;
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( !( o instanceof TaskProgress ) )
        {
            return false;
        }

        final TaskProgress that = (TaskProgress) o;
        return current == that.current && total == that.total && info.equals( that.info );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( current, total, info );
    }

    @Override
    public String toString()
    {
        return MoreObjects.toStringHelper( this ).add( "current", current ).add( "total", total ).add( "info", info ).toString();
    }

    public Builder copy()
    {
        return new Builder( this );
    }

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

    public static final class Builder
    {
        private int current;

        private int total;

        private String info;

        private Builder()
        {
        }

        private Builder( final TaskProgress source )
        {
            current = source.current;
            total = source.total;
            info = source.info;
        }

        public Builder current( final int current )
        {
            this.current = current;
            return this;
        }

        public Builder total( final int total )
        {
            this.total = total;
            return this;
        }

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

        public TaskProgress build()
        {
            return new TaskProgress( this );
        }
    }
}