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.model;
018
019import javax.xml.bind.annotation.XmlAccessType;
020import javax.xml.bind.annotation.XmlAccessorType;
021import javax.xml.bind.annotation.XmlAttribute;
022import javax.xml.bind.annotation.XmlRootElement;
023
024import org.apache.camel.Endpoint;
025import org.apache.camel.ExchangePattern;
026import org.apache.camel.spi.Metadata;
027
028/**
029 * Sends the message to a static endpoint
030 *
031 * @version 
032 */
033@Metadata(label = "eip,endpoint,routing")
034@XmlRootElement(name = "to")
035@XmlAccessorType(XmlAccessType.FIELD)
036public class ToDefinition extends SendDefinition<ToDefinition> {
037    @XmlAttribute
038    private ExchangePattern pattern;
039
040    public ToDefinition() {
041    }
042
043    public ToDefinition(String uri) {
044        setUri(uri);
045    }
046
047    public ToDefinition(Endpoint endpoint) {
048        setEndpoint(endpoint);
049    }
050
051    public ToDefinition(String uri, ExchangePattern pattern) {
052        this(uri);
053        this.pattern = pattern;
054    }
055
056    public ToDefinition(Endpoint endpoint, ExchangePattern pattern) {
057        this(endpoint);
058        this.pattern = pattern;
059    }
060
061    @Override
062    public String toString() {
063        return "To[" + getLabel() + "]";
064    }
065
066    @Override
067    public ExchangePattern getPattern() {
068        return pattern;
069    }
070
071    /**
072     * Sets the optional {@link ExchangePattern} used to invoke this endpoint
073     */
074    public void setPattern(ExchangePattern pattern) {
075        this.pattern = pattern;
076    }
077
078    /**
079     * Sets the optional {@link ExchangePattern} used to invoke this endpoint
080     *
081     * @deprecated will be removed in the near future. Instead use {@link ProcessorDefinition#inOnly()}
082     * or {@link ProcessorDefinition#inOut()}
083     */
084    @Deprecated
085    public ToDefinition pattern(ExchangePattern pattern) {
086        setPattern(pattern);
087        return this;
088    }
089
090}