com.enonic.xp.app.ApplicationKey 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.app;

import java.io.Serializable;

import org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;

import com.google.common.base.Preconditions;

import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.util.CharacterChecker;

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

    public static final ApplicationKey SYSTEM = ApplicationKey.from( "system" );

    public static final ApplicationKey MEDIA_MOD = ApplicationKey.from( "media" );

    public static final ApplicationKey PORTAL = ApplicationKey.from( "portal" );

    public static final ApplicationKey BASE = ApplicationKey.from( "base" );

    public static final ApplicationKeys SYSTEM_RESERVED_APPLICATION_KEYS = ApplicationKeys.from( SYSTEM, MEDIA_MOD, PORTAL, BASE );

    private final String name;

    private ApplicationKey( final String name )
    {
        Preconditions.checkNotNull( name, "ApplicationKey cannot be null" );
        Preconditions.checkArgument( !name.isBlank(), "ApplicationKey cannot be blank" );
        this.name = CharacterChecker.check( name, "Not a valid ApplicationKey [" + name + "]" );
    }

    public String getName()
    {
        return name;
    }

    @Override
    public String toString()
    {
        return name;
    }

    @Override
    public boolean equals( final Object o )
    {
        return this == o || o instanceof ApplicationKey && this.name.equals( ( (ApplicationKey) o ).name );
    }

    @Override
    public int hashCode()
    {
        return this.name.hashCode();
    }

    public static ApplicationKey from( final String name )
    {
        return new ApplicationKey( name );
    }

    public static ApplicationKey from( final Bundle bundle )
    {
        return ApplicationKey.from( bundle.getSymbolicName() );
    }

    public static ApplicationKey from( final Class clzz )
    {
        return from( FrameworkUtil.getBundle( clzz ) );
    }

    public static ApplicationKey from( final String name, final String preffix )
    {
        return new ApplicationKey( name != null ? name.replace( preffix, "." ) : "" );
    }
}