io.github.eocqrs.kafka.Params Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eo-kafka Show documentation

EO Kafka Producers and consumers for working with Apache Kafka message broker

There is a newer version: 0.5.6

/*
 *  Copyright (c) 2022 Aliaksei Bialiauski, EO-CQRS
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package io.github.eocqrs.kafka;

import java.util.Collection;

/**
 * Settings attribute.
 *
 * @author Aliaksei Bialiauski ([email protected])
 * @author Ivan Ivanchuck ([email protected])
 * @since 0.0.2
 */
public interface Params {

  /**
   * Returns a collection of all the settings attributes.
   *
   * @return A collection of SettingsAttribute objects.
   */
  Collection all();

  /**
   * Returns the XML representation of the settings.
   *
   * @return The return value is a string.
   */
  String asXml();
}