Method createComment

code/src/java/pcgen/io/PCGVer2Creator.java:2539–2571

Convenience Method author: Thomas Behr 19-03-02 @param s the String which will be converted into a comment; i.e. '#','\r' will be removed, '\t','\f' will be replaced with ' ', and each line will start with "# " @return the newly created comment

(String s)

	 * @return the newly created comment
	 */
	private static String createComment(String s)
	{
		String work = s + IOConstants.LINE_SEP;
		work = work.replace('\t', ' ');
		work = work.replace('\f', ' ');

		StringBuilder buffer = new StringBuilder(work.length() + 100);
		StringTokenizer tokens = new StringTokenizer(work, "#"); //$NON-NLS-1$

		while (tokens.hasMoreTokens())
		{
			buffer.append(tokens.nextToken());
		}

		work = buffer.toString();

		buffer.setLength(0);

		/*
		 * Need to keep the Windows line separator as newline delimiter to ensure
		 * cross-platform portability.
		 *
		 * author: Thomas Behr 2002-11-13
		 */
		tokens = new StringTokenizer(work, "\r\n"); //$NON-NLS-1$

		while (tokens.hasMoreTokens())
		{
			buffer.append("# ").append(tokens.nextToken()).append(IOConstants.LINE_SEP); //$NON-NLS-1$
		}

		return buffer.toString();
	}

	/**
	 * creates a unique tuple based on the creator and target getName()