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     */
017    package org.apache.camel.model;
018    
019    import javax.xml.bind.annotation.XmlAccessType;
020    import javax.xml.bind.annotation.XmlAccessorType;
021    import javax.xml.bind.annotation.XmlAttribute;
022    import javax.xml.bind.annotation.XmlRootElement;
023    
024    import org.apache.camel.Expression;
025    import org.apache.camel.Processor;
026    import org.apache.camel.model.language.ExpressionDefinition;
027    import org.apache.camel.processor.LoopProcessor;
028    import org.apache.camel.spi.RouteContext;
029    
030    /**
031     * Represents an XML <loop/> element
032     *
033     * @version 
034     */
035    @XmlRootElement(name = "loop")
036    @XmlAccessorType(XmlAccessType.FIELD)
037    public class LoopDefinition extends ExpressionNode {
038    
039        @XmlAttribute
040        private Boolean copy;
041    
042        public LoopDefinition() {
043        }
044    
045        public LoopDefinition(Expression expression) {
046            super(expression);
047        }
048    
049        public LoopDefinition(ExpressionDefinition expression) {
050            super(expression);
051        }
052    
053        /**
054         * Enables copy mode so a copy of the input Exchange is used for each iteration.
055         * That means each iteration will start from a copy of the same message.
056         * <p/>
057         * By default loop will loop the same exchange all over, so each iteration may
058         * have different message content.
059         *
060         * @return the builder
061         */
062        public LoopDefinition copy() {
063            setCopy(true);
064            return this;
065        }
066    
067        public void setExpression(Expression expr) {
068            setExpression(new ExpressionDefinition(expr));
069        }
070    
071        public Boolean getCopy() {
072            return copy;
073        }
074    
075        public void setCopy(Boolean copy) {
076            this.copy = copy;
077        }
078    
079        public boolean isCopy() {
080            // do not copy by default to be backwards compatible
081            return copy != null ? copy : false;
082        }
083    
084        @Override
085        public String toString() {
086            return "Loop[" + getExpression() + " -> " + getOutputs() + "]";
087        }
088        
089        @Override
090        public String getLabel() {
091            return "loop[" + getExpression() + "]";
092        }
093        
094        @Override
095        public String getShortName() {
096            return "loop";
097        }
098    
099        @Override
100        public Processor createProcessor(RouteContext routeContext) throws Exception {
101            Processor output = this.createChildProcessor(routeContext, true);
102            return new LoopProcessor(output, getExpression().createExpression(routeContext), isCopy());
103        }
104        
105    }