nifi-registry/nifi-registry-core/nifi-registry-data-model/src/main/java/org/apache/nifi/registry/extension/bundle/BundleFilterParams.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nifi.registry.extension.bundle;

/**
 * Filter parameters for retrieving extension bundles.
 *
 * Any combination of fields may be provided to filter on the provided values.
 *
 * Note: This class is currently not part of the REST API so it doesn't not have the Swagger annotations, but it is used
 * in the service layer and client to pass around params.
 *
 */
public class BundleFilterParams {

    private static final BundleFilterParams EMPTY_PARAMS = new Builder().build();

    private final String bucketName;
    private final String groupId;
    private final String artifactId;

    private BundleFilterParams(final Builder builder) {
        this.bucketName = builder.bucketName;
        this.groupId = builder.groupId;
        this.artifactId = builder.artifactId;
    }

    public String getBucketName() {
        return bucketName;
    }

    public String getGroupId() {
        return groupId;
    }

    public String getArtifactId() {
        return artifactId;
    }

    public static BundleFilterParams of(final String bucketName, final String groupId, final String artifactId) {
        return new Builder().bucket(bucketName).group(groupId).artifact(artifactId).build();
    }

    public static BundleFilterParams of(final String groupId, final String artifactId) {
        return new Builder().group(groupId).artifact(artifactId).build();
    }

    public static BundleFilterParams empty() {
        return EMPTY_PARAMS;
    }

    public static class Builder {

        private String bucketName;
        private String groupId;
        private String artifactId;

        public Builder bucket(final String bucketName) {
            this.bucketName = bucketName;
            return this;
        }

        public Builder group(final String groupId) {
            this.groupId = groupId;
            return this;
        }

        public Builder artifact(final String artifactId) {
            this.artifactId = artifactId;
            return this;
        }

        public BundleFilterParams build() {
            return new BundleFilterParams(this);
        }
    }

}