001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.builder;
018
019import java.util.Map;
020
021import org.apache.camel.EndpointConsumerResolver;
022
023/**
024 * Type-safe endpoint DSL for building consumer endpoints.
025 *
026 * @see EndpointProducerBuilder
027 */
028public interface EndpointConsumerBuilder extends EndpointConsumerResolver {
029    /**
030     * Builds the url of this endpoint. This API is only intended for Camel
031     * internally.
032     */
033    String getUri();
034
035    /**
036     * Adds an option to this endpoint. This API is only intended for Camel
037     * internally.
038     */
039    void doSetProperty(String name, Object value);
040
041    /**
042     * Adds a multi-value option to this endpoint. This API is only intended for Camel
043     * internally.
044     */
045    void doSetMultiValueProperty(String name, String key, Object value);
046
047    /**
048     * Adds multi-value options to this endpoint. This API is only intended for Camel
049     * internally.
050     */
051    void doSetMultiValueProperties(String name, String prefix, Map<String, Object> values);
052
053}