io.sarl.maven.docs.parser.SectionNumber Maven / Gradle / Ivy
Show all versions of io.sarl.maven.docs.generator Show documentation
/*
* $Id: io/sarl/maven/docs/parser/SectionNumber.java v0.10.0 2019-10-26 17:20:53$
*
* SARL is an general-purpose agent programming language.
* More details on http://www.sarl.io
*
* Copyright (C) 2014-2019 the original authors or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.sarl.maven.docs.parser;
import java.text.MessageFormat;
import java.util.LinkedList;
/** A number of section.
*
* @author Stéphane Galland
* @version 0.10.0 2019-10-26 17:20:53
* @mavengroupid io.sarl.maven
* @mavenartifactid io.sarl.maven.docs.generator
* @since 0.6
*/
public class SectionNumber {
/** The default format, compatible with {@link MessageFormat} for the section numbers.
*/
public static final String DEFAULT_SECTION_NUMBER_FORMAT = "{0}.{1}"; //$NON-NLS-1$
private final LinkedList numbers = new LinkedList<>();
/** Constructor.
*/
public SectionNumber() {
this.numbers.add(0);
}
/** Change this version number from the given string representation.
*
* The string representation should be integer numbers, separated by dot characters.
*
* @param sectionNumber the string representation of the version number.
* @param level is the level at which the section number is visible (1 for the top level, 2 for subsections...)
*/
public void setFromString(String sectionNumber, int level) {
assert level >= 1;
final String[] numbers = sectionNumber.split("[^0-9]+"); //$NON-NLS-1$
final int len = Math.max(0, this.numbers.size() - numbers.length);
for (int i = 0; i < len; ++i) {
this.numbers.removeLast();
}
for (int i = 0; i < numbers.length && i < level; ++i) {
this.numbers.addLast(Integer.valueOf(numbers[i]));
}
}
/** Change this version number by incrementing the number for the given level.
*
* @param level is the level at which the section number is visible (1 for the top level, 2 for subsections...)
*/
public void increment(int level) {
assert level >= 1;
if (this.numbers.size() < level) {
do {
this.numbers.addLast(0);
} while (this.numbers.size() < level);
} else if (this.numbers.size() > level) {
do {
this.numbers.removeLast();
} while (this.numbers.size() > level);
}
assert this.numbers.size() == level;
final int previousSection = this.numbers.removeLast();
this.numbers.addLast(previousSection + 1);
}
/** Format the section numbers.
*
* @return the formatted section number.
*/
@Override
public String toString() {
return toString(DEFAULT_SECTION_NUMBER_FORMAT);
}
/** Format the section numbers.
*
* @param format the format. It must be compatible with {@link MessageFormat}, with
* the first parameter {0} equals to the first part of the full section number, and
* the second parameter {1} equals to a single section number.
* @return the formatted section number.
*/
public String toString(String format) {
String str = null;
for (final Integer nb : this.numbers) {
if (str == null) {
str = nb.toString();
} else {
str = MessageFormat.format(format, str, nb.toString());
}
}
return str;
}
}