001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.util.stream.window;
031
032/**
033 * A payload with metadata
034 * 
035 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
036 * 
037 * @param <PAYLOAD>
038 * @param <META>
039 */
040public class MetaPayload<PAYLOAD, META> {
041        private PAYLOAD payload;
042        private META meta;
043
044        /**
045         * @param payload
046         * @param meta
047         */
048        public MetaPayload(PAYLOAD payload, META meta) {
049                this.payload = payload;
050                this.meta = meta;
051        }
052
053        /**
054         * @return the payload items in this window
055         */
056        public PAYLOAD getPayload() {
057                return this.payload;
058        }
059
060        /**
061         * @return infromation about the window
062         */
063        public META getMeta() {
064                return this.meta;
065        }
066
067        /**
068         * Create a new {@link MetaPayload} created from the given payload and
069         * metadata
070         * 
071         * @param a
072         *            the payload
073         * @param b
074         *            the metadata
075         * @return a new {@link MetaPayload} created from the given payload and
076         *         metadata
077         */
078        public static <A, B> MetaPayload<A, B> create(A a, B b)
079        {
080                return new MetaPayload<A, B>(a, b);
081        }
082}