geode-management/src/main/java/org/apache/geode/management/api/ClusterManagementGetResult.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.geode.management.api;

import java.util.List;

import com.fasterxml.jackson.annotation.JsonIgnore;

import org.apache.geode.annotations.Experimental;
import org.apache.geode.management.configuration.AbstractConfiguration;
import org.apache.geode.management.runtime.RuntimeInfo;

/**
 *
 * @param <T> the type of the static config, e.g. RegionConfig
 * @param <R> the type of the corresponding runtime information, e.g. RuntimeRegionInfo
 */
@Experimental
public class ClusterManagementGetResult<T extends AbstractConfiguration<R>, R extends RuntimeInfo>
    extends ClusterManagementResult {
  /**
   * for internal use only
   */
  public ClusterManagementGetResult() {}

  /**
   * for internal use only
   */
  public ClusterManagementGetResult(ClusterManagementListResult<T, R> singletonListResult) {
    super(singletonListResult);
    setResult(singletonListResult.getResult().get(0));
  }

  private ConfigurationResult<T, R> result = null;

  /**
   * Returns the combined payload of the get call
   */
  public ConfigurationResult<T, R> getResult() {
    return result;
  }

  /**
   * Returns only the static config portion of the result
   */
  @JsonIgnore
  public T getConfigResult() {
    return result.getConfiguration();
  }

  /**
   * Returns only the runtime information portion of the result
   */
  @JsonIgnore
  public List<R> getRuntimeResult() {
    return result.getRuntimeInfo();
  }

  /**
   * for internal use only
   */
  public void setResult(ConfigurationResult<T, R> result) {
    this.result = result;
  }
}