com.hp.autonomy.hod.client.api.resource.ResourceFlavour Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-hod-client Show documentation
Java Client for communicating with HP Haven OnDemand
There is a newer version: 0.25.3
/*
 * Copyright 2015-2016 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.hod.client.api.resource;

import lombok.Data;

import java.io.Serializable;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

@Data
public class ResourceFlavour implements Serializable {

    private static final long serialVersionUID = -1478092510670076594L;

    /**
     * The flavour of a standard text index
     */
    public static final ResourceFlavour STANDARD = new ResourceFlavour("standard");

    /**
     * The flavour of an explorer text index
     */
    public static final ResourceFlavour EXPLORER = new ResourceFlavour("explorer");

    /**
     * The flavour of a categorization text index
     */
    public static final ResourceFlavour CATEGORIZATION = new ResourceFlavour("categorization");

    /**
     * The flavour of a custom fields text index
     */
    public static final ResourceFlavour CUSTOM_FIELDS = new ResourceFlavour("custom_fields");

    /**
     * The flavour of a query manipulation text index
     */
    public static final ResourceFlavour QUERY_MANIPULATION = new ResourceFlavour("querymanipulation");

    /**
     * The flavour of a web cloud connector
     */
    public static final ResourceFlavour WEB_CLOUD = new ResourceFlavour("web_cloud");

    /**
     * The flavour of an on site filesystem connector
     */
    public static final ResourceFlavour FILESYSTEM_ONSITE = new ResourceFlavour("filesystem_onsite");

    public static final ResourceFlavour JUMBO = new ResourceFlavour("jumbo");

    private final String name;

    /**
     * Creates a new ResourceFlavour with the given name
     * @param name The name of the ResourceFlavour
     */
    public ResourceFlavour(final String name) {
        this.name = name;
    }

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

    /**
     * @return A set containing all the ResourceFlavour instances declared in static fields
     */
    public static Set allOf() {
        return new HashSet<>(Arrays.asList(
            STANDARD,
            EXPLORER,
            CATEGORIZATION,
            CUSTOM_FIELDS,
            QUERY_MANIPULATION,
            JUMBO,
            WEB_CLOUD,
            FILESYSTEM_ONSITE
        ));
    }

    /**
     * Returns a set containing all the known resource flavours, except those is the given set
     * @param resourceFlavours The resource flavours which will not be included in the returned set
     * @return The complement of the given set of resource flavours
     */
    public static Set complementOf(final Set resourceFlavours) {
        final Set set = allOf();

        set.removeAll(resourceFlavours);

        return set;
    }

    /**
     * Returns a set containing the given resource flavours
     * @param first The first resource flavour to add
     * @param rest The remaining resource flavours to add
     * @return A set containing the given resource flavours
     */
    public static Set of(final ResourceFlavour first, final ResourceFlavour... rest) {
        final Set set = new HashSet<>();
        set.add(first);
        set.addAll(Arrays.asList(rest));

        return set;
    }
}