Skip to content

Responsible for replacing all characters reserved by the operating system with others according to a mapping.

License

Notifications You must be signed in to change notification settings

wniemiec-util-java/reserved-character-replacer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Reserved Character Replacer

Responsible for replacing all characters reserved by the operating system with others according to a mapping.

Coverage status Java compatibility Maven Central release License


❇ Introduction

If you need to know if a piece of code has already been executed by another process, then this is the perfect library for you. A reserved-character-replacer is a class and method marker, and it is used when you want a piece of code, even if executed by several independent processes, to be executed only once.

❓ How to use

  1. Add one of the options below to the pom.xml file:

Using Maven Central (recomended):

<dependency>
  <groupId>io.github.wniemiec-util-java</groupId>
  <artifactId>reserved-character-replacer</artifactId>
  <version>LATEST</version>
</dependency>

Using GitHub Packages:

<dependency>
  <groupId>wniemiec.util.java</groupId>
  <artifactId>reserved-character-replacer</artifactId>
  <version>LATEST</version>
</dependency>
  1. Run
$ mvn install
  1. Use it
[...]

import wniemiec.util.java.ReservedCharactersReplacerFactory;
import wniemiec.util.java.Replacer;

[...]

Replacer replacer = ReservedCharactersReplacerFactory.getStandardReplacer();
String reservedCharacters = "<>/\\:\"|?*";

System.out.println( replacer.replace(reservedCharacters) );

[...]

📖 Documentation

Property Parameter type Return type Description Default parameter value
replace str: String String Replaces all reserved characters with others. -

🚩 Changelog

Details about each version are documented in the releases section.

🤝 Contribute!

See the documentation on how you can contribute to the project here.

📁 Files

/

Name Type Description
dist Directory Released versions
docs Directory Documentation files
src Directory Source files