com.github.tomakehurst.wiremock.common.Metadata Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation
A web service test double for all occasions - standalone edition
There is a newer version: 3.9.1
/*
 * Copyright (C) 2018-2023 Thomas Akehurst
 *
 * Licensed 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 com.github.tomakehurst.wiremock.common;

import static com.github.tomakehurst.wiremock.common.ParameterUtils.checkParameter;

import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

public class Metadata extends LinkedHashMap {

  public Metadata() {}

  public Metadata(Map data) {
    super(data);
  }

  public Integer getInt(String key) {
    return checkPresenceValidityAndCast(key, Integer.class);
  }

  public Integer getInt(String key, Integer defaultValue) {
    return returnIfValidOrDefaultIfNot(key, Integer.class, defaultValue);
  }

  public Boolean getBoolean(String key) {
    return checkPresenceValidityAndCast(key, Boolean.class);
  }

  public Boolean getBoolean(String key, Boolean defaultValue) {
    return returnIfValidOrDefaultIfNot(key, Boolean.class, defaultValue);
  }

  public String getString(String key) {
    return checkPresenceValidityAndCast(key, String.class);
  }

  public String getString(String key, String defaultValue) {
    return returnIfValidOrDefaultIfNot(key, String.class, defaultValue);
  }

  public List getList(String key) {
    return checkPresenceValidityAndCast(key, List.class);
  }

  @SuppressWarnings("unchecked")
  public Metadata getMetadata(String key) {
    checkKeyPresent(key);
    checkParameter(Map.class.isAssignableFrom(get(key).getClass()), key + " is not a map");
    return new Metadata((Map) get(key));
  }

  public Metadata getMetadata(String key, Metadata defaultValue) {
    if (!containsKey(key)) {
      return defaultValue;
    }

    checkParameter(Map.class.isAssignableFrom(get(key).getClass()), key + " is not a map");
    return new Metadata((Map) get(key));
  }

  @SuppressWarnings("unchecked")
  private  T checkPresenceValidityAndCast(String key, Class type) {
    checkKeyPresent(key);
    checkParameter(
        type.isAssignableFrom(get(key).getClass()),
        key + " is not of type " + type.getSimpleName());
    return (T) get(key);
  }

  @SuppressWarnings("unchecked")
  private  T returnIfValidOrDefaultIfNot(String key, Class type, T defaultValue) {
    if (!containsKey(key) || !type.isAssignableFrom(get(key).getClass())) {
      return defaultValue;
    }

    return (T) get(key);
  }

  private void checkKeyPresent(String key) {
    checkParameter(containsKey(key), key + "' not present");
  }

  public static  Metadata from(T myData) {
    return new Metadata(Json.objectToMap(myData));
  }

  public static Builder metadata() {
    return new Builder();
  }

  public  T as(Class myDataClass) {
    return Json.mapToObject(this, myDataClass);
  }

  public static class Builder {

    private final Map mapBuilder;

    public Builder() {
      this.mapBuilder = new LinkedHashMap<>();
    }

    public Builder attr(String key, Object value) {
      mapBuilder.put(key, value);
      return this;
    }

    public Builder list(String key, Object... values) {
      mapBuilder.put(key, List.of(values));
      return this;
    }

    public Builder attr(String key, Metadata.Builder metadataBuilder) {
      mapBuilder.put(key, metadataBuilder.build());
      return this;
    }

    public Metadata build() {
      return new Metadata(mapBuilder);
    }
  }
}