org.mule.runtime.api.metadata.MetadataKeysContainerBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mule-api Show documentation

API for Mule Runtime

There is a newer version: 1.1.1

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package org.mule.runtime.api.metadata;

import org.mule.runtime.api.metadata.resolving.TypeKeysResolver;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * Builder for {@link MetadataKeysContainer}
 * 
 * @since 1.0
 */
public final class MetadataKeysContainerBuilder {

  private Map> keyMap = new HashMap<>();

  private MetadataKeysContainerBuilder() {}

  public static MetadataKeysContainerBuilder getInstance() {
    return new MetadataKeysContainerBuilder();
  }

  /**
   * @param name {@link Class#getSimpleName()} or alias of the {@link TypeKeysResolver} class
   * @param keys {@link Set} associated to the category.
   *                                     @return {@code} this builder
   */
  public MetadataKeysContainerBuilder add(String name, Set keys) {
    keyMap.put(name, keys);
    return this;
  }

  /**
   * @param keys a {@link Map} which keys are categories and values are {@link MetadataKey}s associated to them
   * @return {@code} this builder
   */
  public MetadataKeysContainerBuilder addAll(Map> keys) {
    keyMap.putAll(keys);
    return this;
  }

  /**
   * @return {@code true} if the category was already added
   */
  public boolean containsCategory(String categoryName) {
    return keyMap.containsKey(categoryName);
  }

  /**
   * @return {@link DefaultMetadataKeysContainer} with the built keys.
   */
  public MetadataKeysContainer build() {
    return new DefaultMetadataKeysContainer(keyMap);
  }
}