com.enonic.xp.content.ContentPath 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.content;

import java.util.List;
import java.util.Objects;

import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;

import com.enonic.xp.annotation.PublicApi;

@PublicApi
public final class ContentPath
{
    public static final ContentPath ROOT = create().absolute( true ).build();

    private static final String ELEMENT_DIVIDER = "/";

    private final boolean absolute;

    private final List elements;

    private ContentPath( final Builder builder )
    {
        Preconditions.checkNotNull( builder.elements );
        this.absolute = builder.absolute;
        this.elements = builder.elements.build();
    }

    public String getElement( final int index )
    {
        return this.elements.get( index );
    }

    public boolean isRoot()
    {
        return this.elements.isEmpty();
    }

    public int elementCount()
    {
        return this.elements.size();
    }

    public ContentPath getParentPath()
    {
        return getAncestorPath( 1 );
    }

    public ContentPath getAncestorPath( final int deep )
    {
        final int size = this.elements.size();

        if ( size < deep )
        {
            return null;
        }

        final int subIndex = size - deep;
        final List parentElements = this.elements.subList( 0, subIndex );

        return create().absolute( absolute ).elements( parentElements ).build();
    }

    public boolean isAbsolute()
    {
        return absolute;
    }

    @Deprecated
    public boolean isRelative()
    {
        return !absolute;
    }

    @Deprecated
    public ContentPath asRelative()
    {
        if ( !absolute )
        {
            return this;
        }

        return new ContentPath.Builder( this ).absolute( false ).build();
    }

    public ContentPath asAbsolute()
    {
        if ( absolute )
        {
            return this;
        }

        return new ContentPath.Builder( this ).absolute( true ).build();
    }

    public boolean hasName()
    {
        return !elements.isEmpty();
    }

    public String getName()
    {
        return elements.isEmpty() ? null : elements.get( elements.size() - 1 );
    }

    public boolean isChildOf( final ContentPath possibleParentPath )
    {
        if ( elementCount() <= possibleParentPath.elementCount() )
        {
            return false;
        }

        for ( int i = 0; i < possibleParentPath.elementCount(); i++ )
        {
            if ( !elements.get( i ).equalsIgnoreCase( possibleParentPath.getElement( i ) ) )
            {
                return false;
            }
        }

        return true;
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( !( o instanceof ContentPath ) )
        {
            return false;
        }
        final ContentPath that = (ContentPath) o;
        return absolute == that.absolute && elements.equals( that.elements );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( absolute, elements );
    }

    @Deprecated
    public int compareTo( ContentPath contentPath )
    {
        return this.toString().compareTo( contentPath.toString() );
    }

    @Override
    public String toString()
    {
        return ( this.absolute ? ELEMENT_DIVIDER : "" ) + String.join( ELEMENT_DIVIDER, elements );
    }

    public static ContentPath from( final String path )
    {
        final Iterable pathElements = Splitter.on( ELEMENT_DIVIDER ).omitEmptyStrings().split( path );
        boolean absolute = path.startsWith( ELEMENT_DIVIDER );
        return create().elements( pathElements ).absolute( absolute ).build();
    }

    public static ContentPath from( final ContentPath parent, final String name )
    {
        return create().elements( parent.elements ).absolute( parent.isAbsolute() ).addElement( name ).build();
    }

    public static ContentPath from( final ContentPath parent, final ContentPath relative )
    {
        final Builder builder = create().elements( parent.elements );
        builder.addElements( relative.elements );
        builder.absolute( parent.isAbsolute() );
        return builder.build();
    }


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

    public static final class Builder
    {
        private ImmutableList.Builder elements;

        private boolean absolute = true;

        private Builder()
        {
            this.elements = ImmutableList.builder();
        }

        private Builder( ContentPath source )
        {
            this.elements = ImmutableList.builder();
            this.elements.addAll( source.elements );
            this.absolute = source.absolute;
        }

        public Builder absolute( final boolean value )
        {
            this.absolute = value;
            return this;
        }

        public Builder elements( final String... pathElements )
        {
            this.elements = ImmutableList.builder();
            for ( String pathElement : pathElements )
            {
                validatePathElement( pathElement );
                this.elements.add( pathElement );
            }
            return this;
        }

        public Builder elements( final Iterable pathElements )
        {
            this.elements = ImmutableList.builder();
            for ( String pathElement : pathElements )
            {
                validatePathElement( pathElement );
                this.elements.add( pathElement );
            }
            return this;
        }

        public Builder addElement( final String pathElement )
        {
            validatePathElement( pathElement );
            this.elements.add( pathElement );
            return this;
        }

        public void addElements( final List elements )
        {
            elements.forEach( this::addElement );
        }

        private void validatePathElement( final String pathElement )
        {
            Preconditions.checkNotNull( pathElement, "A path element cannot be null" );
            Preconditions.checkArgument( !pathElement.isEmpty(), "A path element cannot be empty" );
            Preconditions.checkArgument( !pathElement.contains( ELEMENT_DIVIDER ),
                                         "A path element cannot contain an element divider '%s': [%s]", ELEMENT_DIVIDER, pathElement );
        }

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