JSingleLineCommentStatement.java

/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 * Portions Copyright 2013-2017 Philip Helger + contributors
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.helger.jcodemodel;

import javax.annotation.Nonnull;

import com.helger.jcodemodel.util.JCValueEnforcer;

/**
 * This class represents a special single-comment "statement"! This is not an
 * ideal solution but it gives you an easy way to add single line comments to
 * generated code.
 *
 * @author Philip Helger
 * @since 2.8.3
 */
public class JSingleLineCommentStatement implements IJStatement
{
  private String m_sComment;

  /**
   * Constructor.
   *
   * @param sComment
   *        The new comment string. May not be <code>null</code> but maybe
   *        empty.
   */
  public JSingleLineCommentStatement (@Nonnull final String sComment)
  {
    comment (sComment);
  }

  /**
   * @return The current comment string, without the leading "//".
   */
  @Nonnull
  public String comment ()
  {
    return m_sComment;
  }

  /**
   * Set a new comment string.
   *
   * @param sComment
   *        The new comment string. May not be <code>null</code> but maybe
   *        empty.
   */
  public void comment (@Nonnull final String sComment)
  {
    JCValueEnforcer.notNull (sComment, "Comment");
    m_sComment = sComment;
  }

  public void state (@Nonnull final JFormatter f)
  {
    if (m_sComment.length () > 0)
      f.print ("// ").print (m_sComment).newline ();
    else
      f.print ("//").newline ();
  }
}