net.sourceforge.jenesis4java.Comment Maven / Gradle / Ivy

Go to download

package net.sourceforge.jenesis4java; /* * #%L * Jenesis 4 Java Code Generator * %% * Copyright (C) 2000 - 2015 jenesis4java * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Lesser Public License for more details. * * You should have received a copy of the GNU General Lesser Public * License along with this program. If not, see * . * #L% */ /** * Copyright (C) 2008, 2010 Richard van Nieuwenhoven - ritchie [at] gmx [dot] at * Copyright (C) 2000, 2001 Paul Cody Johnston - [email protected] * This file is part of Jenesis4java. Jenesis4java is free software: you can * redistribute it and/or modify it under the terms of the GNU Lesser General * Public License as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. * Jenesis4java is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more * details. * You should have received a copy of the GNU Lesser General Public License * along with Jenesis4java. If not, see . */ /** * The {@code Comment} superinterface. */ public interface Comment extends Codeable { /** * Type constant for a single line comment. */ int SINGLE_LINE = 1; /** * Type constant for a single line comment. * * @deprecated prefer more descriptive {@link #SINGLE_LINE} */ @Deprecated int S = SINGLE_LINE; /** * Type constant for a multiple line comment. */ int MULTI_LINE = 2; /** * Type constant for a multiple line comment. * * @deprecated prefer more descriptive {@link #MULTI_LINE} */ @Deprecated int M = MULTI_LINE; /** * Type constant for a multiple line comment, but only at the beginning and * at the end. * * @deprecated This will be removed in the future. Use {@link #MULTI_LINE} * instead. */ @Deprecated int BLOCK_WITHOUT_INTERMEDIARY_STARS = 3; /** * Type constant for a multiple line comment, but only at the beginning and * at the end. * * @deprecated prefer more descriptive * {@link #BLOCK_WITHOUT_INTERMEDIARY_STARS} */ @Deprecated int Mbe = BLOCK_WITHOUT_INTERMEDIARY_STARS; /** * Type constant for a documentation comment. */ int DOCUMENTATION = 4; /** * Type constant for a documentation comment. * * @deprecated prefer more descriptive {@link #DOCUMENTATION} */ @Deprecated int D = DOCUMENTATION; /** * Type constant for a trailing comment. A trailing comment is on the same * line as the element. * * If putting the comment in a trailing position fails, it will be treated * like a {@link #SINGLE_LINE} comment. *

* Note: Feature is still incomplete and is tested on statements only. */ int TRAILING = 5; /** * Gets the text for this comment. */ String getText(); /** * Sets the text for this comment. */ Comment setText(String text); /** * Returns the type of this comment. * * @deprecated Name does not follow naming convention. Use * {@link #getType()} instead. */ @Deprecated int type(); /** * Returns the type of this comment. */ int getType(); }