org.mule.runtime.config.api.dsl.model.ConfigurationParameters Maven / Gradle / Ivy
/*
* 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.config.api.dsl.model;
import org.mule.api.annotation.NoImplement;
import org.mule.runtime.api.component.ComponentIdentifier;
import org.mule.runtime.api.util.Pair;
import java.util.List;
/**
* Representation of the DSL configuration parameters of a component.
*
* @since 4.1
*/
@NoImplement
public interface ConfigurationParameters {
/**
* Gets the value of a simple parameter as an string.
*
* @param parameterName parameter name, same as in the config.
* @return the parameter value as an string.
*/
String getStringParameter(String parameterName);
/**
* Gets all the configuration of a complex parameter type with an specific {@link ComponentIdentifier}.
*
* @param componentIdentifier the component identifier of the parameter.
* @return the complex parameter with the given {@link ComponentIdentifier}
*/
List getComplexConfigurationParameter(ComponentIdentifier componentIdentifier);
/**
* Gets all the complex parameters and they related identifier
*
* @return all the complex parameters.
*/
List> getComplexConfigurationParameters();
}