com.enonic.xp.region.Component 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.region;

import java.util.Objects;

import com.google.common.base.MoreObjects;

import com.enonic.xp.annotation.PublicApi;

@PublicApi
public abstract class Component
{
    private Region region = null;

    protected Component( final Builder properties )
    {
    }

    public abstract ComponentType getType();

    @Deprecated
    public ComponentName getName()
    {
        return null;
    }

    public ComponentPath getPath()
    {
        return region == null ? null : ComponentPath.from( region.getRegionPath(), region.getIndex( this ) );
    }

    void setRegion( final Region region )
    {
        this.region = region;
    }

    public abstract Component copy();

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( o == null || getClass() != o.getClass() )
        {
            return false;
        }

        final Component that = (Component) o;

        return Objects.equals( this.getName(), that.getName() );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( this.getName() );
    }

    @Override
    public String toString()
    {
        return MoreObjects.toStringHelper( this ).
            add( "type", getType() ).
            add( "name", this.getName() ).
            add( "path", getPath() ).
            toString();
    }

    public static class Builder
    {
        protected Builder()
        {
            // Default
        }

        protected Builder( Component source )
        {
        }

        @Deprecated
        public Builder name( ComponentName value )
        {
            return this;
        }

    }
}