com.foursoft.xml.IdLookupProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of navigation-extender-runtime Show documentation

There is a newer version: 1.2.4

Show newest version

/*-
 * ========================LICENSE_START=================================
 * xml-runtime
 * %%
 * Copyright (C) 2019 4Soft GmbH
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * =========================LICENSE_END==================================
 */
package com.foursoft.xml;

import java.util.Map;
import java.util.Optional;

/**
 * Provides the possibility to lookup elements by their technical (xml) id. The
 * {@link IdLookupProvider} is normally created during the unmarshalling process
 * by an {@link ExtendedUnmarshaller}.
 *
 * @param  Type of the superclass if elements that are identifiable (have an
 *            id).
 * @author becker
 */
public class IdLookupProvider {

    private final Map idLookup;

    public IdLookupProvider(final Map idLookup) {
        this.idLookup = idLookup;
    }

    public  Optional findById(final Class clazz, final String id) {
        final I i = idLookup.get(id);
        return clazz.isInstance(i) ? (Optional) Optional.of(i) : Optional.empty();
    }

    /**
     * Merges this {@link IdLookupProvider} with toMerge and returns
     * this. Duplicate id mappings are removed, the mappings in
     * toMerge are kept.
     *
     * @param toMerge the id provider to merge
     * @return this for fluent API
     */
    public IdLookupProvider merge(final IdLookupProvider toMerge) {
        idLookup.putAll(toMerge.idLookup);
        return this;
    }

}