org.eclipse.ditto.edge.service.placeholders.ImmutableEntityIdPlaceholder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ditto-edge-service Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

There is a newer version: 3.6.3

/*
 * Copyright (c) 2020 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.edge.service.placeholders;

import static org.eclipse.ditto.base.model.common.ConditionChecker.argumentNotEmpty;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;

import java.util.Collections;
import java.util.List;

import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.base.model.entity.id.EntityId;
import org.eclipse.ditto.base.model.entity.id.NamespacedEntityId;
import org.eclipse.ditto.base.model.entity.id.NamespacedEntityIdInvalidException;

/**
 * Placeholder implementation that replaces {@code entity:id}, {@code entity:namespace} and {@code entity:name}.
 * The input value is a String and must be a valid Entity ID.
 */
@Immutable
final class ImmutableEntityIdPlaceholder extends AbstractEntityIdPlaceholder {

    /**
     * Singleton instance of the ImmutableEntityPlaceholder.
     */
    static final ImmutableEntityIdPlaceholder INSTANCE = new ImmutableEntityIdPlaceholder();

    @Override
    public String getPrefix() {
        return "entity";
    }

    @Override
    public List resolveValues(final EntityId entityId, final String placeholder) {
        argumentNotEmpty(placeholder, "placeholder");
        checkNotNull(entityId, "Entity ID");
        try {
            final NamespacedEntityId namespacedEntityId = NamespacedEntityId.of(entityId.getEntityType(), entityId);
            return doResolve(namespacedEntityId, placeholder);
        } catch (final NamespacedEntityIdInvalidException e) {
            // not a namespaced entity ID; does not resolve.
            return Collections.emptyList();
        }
    }
}