org.eolang.maven.rust.Commented Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eo-maven-plugin Show documentation

EO-to-Java Maven Plugin

There is a newer version: 0.49.2

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2023 Objectionary.com
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.eolang.maven.rust;

import org.eolang.maven.Disclaimer;

/**
 * Commented file.
 * @since 0.30
 */
public final class Commented extends Savable {

    /**
     * Origin file.
     */
    private final Savable origin;

    /**
     * Commentary mark.
     */
    private final String start;

    /**
     * Ctor.
     * @param origin Original object to save.
     * @param start Prefix of commentary.
     */
    public Commented(final Savable origin, final String start) {
        super(
            origin.name,
            origin.ext
        );
        this.origin = origin;
        this.start = start;
    }

    @Override
    String content() {
        return String.format(
            "%s %s%s%s",
            this.start,
            new Disclaimer(),
            System.lineSeparator(),
            this.origin.content()
        );
    }
}