001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.core.collectors;
020
021import org.nuxeo.ecm.automation.OperationContext;
022import org.nuxeo.ecm.automation.OperationException;
023import org.nuxeo.ecm.automation.OutputCollector;
024import org.nuxeo.ecm.automation.core.util.BlobList;
025import org.nuxeo.ecm.core.api.Blob;
026
027/**
028 * This implementation collect {@link Blob} objects and return them as a {@link BlobList} object.
029 * <p>
030 * You may use this to automatically iterate over iterable inputs in operation methods that <b>return</b> a {@link Blob}
031 * object.
032 *
033 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
034 */
035public class BlobCollector extends BlobList implements OutputCollector<Blob, BlobList> {
036
037    private static final long serialVersionUID = 5167860889224514027L;
038
039    @Override
040    public void collect(OperationContext ctx, Blob obj) throws OperationException {
041        if (obj != null) {
042            add(obj);
043        }
044    }
045
046    @Override
047    public BlobList getOutput() {
048        return this;
049    }
050}