com.hp.autonomy.iod.client.api.textindexing.AddToTextIndexReference Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-iod-client Show documentation

Java Client for communicating with IDOL OnDemand

There is a newer version: 0.8.0

/*
 * Copyright 2015 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.iod.client.api.textindexing;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.hp.autonomy.iod.client.error.IodError;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Setter;
import lombok.experimental.Accessors;

/**
 * A reference returned from the AddToTextIndexApi. This class will hold either:
 * A reference and an id
 * or an IodError if something went wrong
 */
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@JsonDeserialize(builder = AddToTextIndexReference.Builder.class)
public class AddToTextIndexReference {

    /**
     * @return The reference of the document
     */
    private final String reference;

    /**
     * @return The id of the document
     */
    private final Integer id;

    /**
     * @return A IodError indicating something went wrong
     */
    private final IodError error;

    @Setter
    @Accessors(chain = true)
    @JsonPOJOBuilder(withPrefix = "set")
    public static class Builder {

        private String reference;
        private Integer id;
        private IodError error;

        public AddToTextIndexReference build() {
            return new AddToTextIndexReference(reference, id, error);
        }

    }

}