- java.lang.Object
-
- org.commonmark.ext.heading.anchor.IdGenerator
-
public class IdGenerator extends java.lang.ObjectGenerates strings to be used as identifiers.Use
builder()to create an instance.
-
-
嵌套类概要
嵌套类 修饰符和类型 类 说明 static classIdGenerator.Builder
-
方法概要
所有方法 静态方法 实例方法 具体方法 修饰符和类型 方法 说明 static IdGenerator.Builderbuilder()java.lang.StringgenerateId(java.lang.String text)Generate an ID based on the provided text and previously generated IDs.
-
-
-
方法详细资料
-
builder
public static IdGenerator.Builder builder()
- 返回:
- a new builder with default arguments
-
generateId
public java.lang.String generateId(java.lang.String text)
Generate an ID based on the provided text and previously generated IDs.
This method is not thread safe, concurrent calls can end up with non-unique identifiers.
Note that collision can occur in the case that
- Method called with 'X'
- Method called with 'X' again
- Method called with 'X-1'
In that case, the three generated IDs will be:
- X
- X-1
- X-1
Therefore if collisions are unacceptable you should ensure that numbers are stripped from end of
text.- 参数:
text- Text that the identifier should be based on. Will be normalised, then used to generate the identifier.- 返回:
textif this is the first instance that thetexthas been passed to the method. Otherwise,text + "-" + Xwill be returned, where X is the number of times thattexthas previously been passed in. Iftextis empty, the default identifier given in the constructor will be used.
-
-