TransformationResult.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.sling.installer.api.tasks;

import java.io.InputStream;
import java.util.Map;

import org.osgi.framework.Version;

/**
 * A result of a {@link ResourceTransformer}.
 *
 * In most cases the new transformation result just contains new
 * content (provided through {@link #getInputStream()}.
 *
 * However, if the transformer is able to detect the new resource
 * type and sets it, it must also provide a unique id (
 * {@link #getResourceType()} and {@link #getId()}.
 */
public class TransformationResult {

    /** A new resource type. */
    private String resourceType;

    /** A new input stream. */
    private InputStream inputStream;

    /** Unique id. */
    private String id;

    /** Optional version. */
    private Version version;

    /** Attributes */
    private Map<String, Object> attributes;

    /**
     * Get the new resource type
     * @return New resource type or <code>null</code>.
     */
    public String getResourceType() {
        return resourceType;
    }

    /**
     * Get the new input stream
     * @return New input stream or <code>null</code>.
     */
    public InputStream getInputStream() {
        return inputStream;
    }

    /**
     * Get the new unique id
     * @return New unique id or <code>null</code>.
     */
    public String getId() {
        return id;
    }

    /**
     * Set a new resource type.
     * @param resourceType The resource type
     */
    public void setResourceType(final String resourceType) {
        this.resourceType = resourceType;
    }

    /**
     * Set a new unique id.
     * @param id The unique id
     */
    public void setId(final String id) {
        this.id = id;
    }

    /**
     * Set a new input stream.
     * @param inputStream The input stream
     */
    public void setInputStream(final InputStream inputStream) {
        this.inputStream = inputStream;
    }

    /**
     * Attributes include the bundle symbolic name, bundle version, etc.
     * @return The map if attributes.
     */
    public Map<String, Object> getAttributes() {
        return this.attributes;
    }

    /**
     * Set the new attributes.
     * @param attr The map of attributes
     */
    public void setAttributes(final Map<String, Object> attr) {
        this.attributes = attr;
    }

    /**
     * Set the version.
     * @param version The new version
     * @since 1.2
     */
    public void setVersion(final Version version) {
        this.version = version;
    }

    /**
     * Get the version
     * @return The version or <code>null</code>
     * @since 1.2
     */
    public Version getVersion() {
        return this.version;
    }

    @Override
    public String toString() {
        return "TransformationResult [resourceType=" + resourceType + ", id=" + id + ", version=" + version
                + ", attributes=" + attributes + "]";
    }

}