com.hp.autonomy.aci.content.identifier.stateid.AbstractStateIds Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of content-parameter-api Show documentation
API for representing aspects of IDOL's Content server, including FieldText and document References
The newest version!
/*
 * Copyright 2009-2015 Open Text.
 *
 * Licensed under the MIT License (the "License"); you may not use this file
 * except in compliance with the License.
 *
 * The only warranties for products and services of Open Text and its affiliates
 * and licensors ("Open Text") are as may be set forth in the express warranty
 * statements accompanying such products and services. Nothing herein should be
 * construed as constituting an additional warranty. Open Text shall not be
 * liable for technical or editorial errors or omissions contained herein. The
 * information contained herein is subject to change without notice.
 */
package com.hp.autonomy.aci.content.identifier.stateid;

import java.util.UUID;

/**
 * An abstract base-class that partially implements the {@link StateIds} interface using sensible defaults.
 */
public abstract class AbstractStateIds implements StateIds {
    private static final String MATCH_NOTHING = "MATCH_NOTHING_" + UUID.randomUUID().toString();

    /**
     *
     * @return {@code "statematchid"} or equivalent
     */
    @Override
    public String getMatchParameterName() {
        return STATE_MATCH_ID;
    }

    /**
     *
     * @return {@code "DRESTATEID"} or equivalent
     */
    @Override
    public String getIndexingIdentifierName() {
        return DRESTATEID;
    }

    /**
     *
     * @return {@code "statedontmatchid"} or equivalent
     */
    @Override
    public String getDontMatchParameterName() {
        return STATE_DONT_MATCH_ID;
    }

    /**
     *
     * @return {@code "stateid"} or equivalent
     */
    @Override
    public String getGetContentParameterName() {
        return STATE_ID;
    }

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

    @Override
    public StateIds append(final String stateId, final int document) {
        return new StateIdsBuilder(this).append(stateId, document);
    }

    @Override
    public StateIds append(final String stateId, final int start, final int end) {
        return new StateIdsBuilder(this).append(stateId, start, end);
    }

    @Override
    public StateIds append(final String stateId, final StateRange range) {
        return new StateIdsBuilder(this).append(stateId, range);
    }


    @Override
    public StateIds append(final String... stateIds) {
        return new StateIdsBuilder(this).append(stateIds);
    }

    @Override
    public StateIds append(final Iterable... stateIds) {
        return new StateIdsBuilder(this).append(stateIds);
    }

    /**
     * Simple implementation that tests for emptiness using size() == 0. In most cases this should be
     * overridden with a better implementation.
     *
     * @return true if and only if size is 0.
     */
    @Override
    public boolean isEmpty() {
        return size() == 0;
    }

    /**
     * Simple implementation that calculates the size by counting the number of elements in the iterator. In most cases
     * this should be overridden with a better implementation.
     *
     * @return {@inheritDoc}
     */
    @Override
    public int size() {
        int size = 0;

        for (final StateId stateId : this) {
            ++size;
        }

        return size;
    }

    @Override
    public boolean equals(final Object obj) {
        return obj == this || obj instanceof StateIds && toString().equals(obj.toString());
    }

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

    @Override
    public String toString() {
        if (isEmpty()) {
            return MATCH_NOTHING;
        }

        final StringBuilder builder = new StringBuilder();

        for (final StateId stateId : this) {
            if (stateId == null) {
                throw new IllegalStateException("Unexpected null state id in iterator");
            }

            builder.append(stateId).append(',');
        }

        if (builder.length() > 0) {
            builder.deleteCharAt(builder.length() - 1);
        }

        return builder.toString();
    }
}