fiftyone.devicedetection.hash.engine.onpremise.interop.ValueIterable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of device-detection.hash.engine.on-premise Show documentation

There is a newer version: 4.5.0-alpha.287

Show newest version

/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
 *
 * This Original Work is licensed under the European Union Public Licence (EUPL) 
 * v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 * 
 * If using the Work as, or as part of, a network application, by 
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading, 
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.devicedetection.hash.engine.onpremise.interop;

import fiftyone.devicedetection.hash.engine.onpremise.data.ValueMetaDataHash;
import fiftyone.devicedetection.hash.engine.onpremise.flowelements.DeviceDetectionHashEngine;
import fiftyone.devicedetection.hash.engine.onpremise.interop.swig.ValueMetaDataCollectionSwig;
import fiftyone.pipeline.engines.fiftyone.data.CollectionIterableBase;
import fiftyone.pipeline.engines.fiftyone.data.ValueMetaData;

/**
 * Class which adds the {@link Iterable} and {@link AutoCloseable} interfaces to
 * a native collection representing {@link ValueMetaData}s.
 */
public class ValueIterable
        extends CollectionIterableBase {

    private final DeviceDetectionHashEngine engine;

    private final ValueMetaDataCollectionSwig collection;

    /**
     * Create a new instance.
     * @param engine the engine which the meta data relates to
     * @param collection the native collection of values
     */
    public ValueIterable(
            DeviceDetectionHashEngine engine,
            ValueMetaDataCollectionSwig collection) {
        super(collection.getSize());
        this.engine = engine;
        this.collection = collection;
    }

    @Override
    protected ValueMetaData get(long index) {
        return new ValueMetaDataHash(engine, collection.getByIndex(index));
    }

    @Override
    public void close() throws Exception {
        collection.delete();
    }
}