001/*
002 * (C) Copyright 2018 Nuxeo (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 *     bdelbosc
018 */
019package org.nuxeo.importer.stream.consumer.watermarker;
020
021import java.nio.file.Path;
022
023/**
024 * @since 10.2
025 */
026public interface Watermarker {
027
028    /**
029     * Creates a new file based on the input file by adding a watermark
030     *
031     * @param inputFile the source file
032     * @param outputDir the directory to write the output file
033     * @param watermark the watermark string to use
034     * @return the path of the watermarked file
035     */
036    Path addWatermark(Path inputFile, Path outputDir, String watermark);
037
038}