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