https://github.com/wniemiec-util-java/reserved-character-replacer
Responsible for replacing all characters reserved by the operating system with others according to a mapping.
https://github.com/wniemiec-util-java/reserved-character-replacer
character-replacer java replacer reserved-character reserved-character-replacer util wniemiec wniemiec-util-java
Last synced: 6 months ago
JSON representation
Responsible for replacing all characters reserved by the operating system with others according to a mapping.
- Host: GitHub
- URL: https://github.com/wniemiec-util-java/reserved-character-replacer
- Owner: wniemiec-util-java
- License: mit
- Created: 2021-08-12T13:41:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-12T15:16:35.000Z (almost 5 years ago)
- Last Synced: 2025-07-11T15:42:54.754Z (12 months ago)
- Topics: character-replacer, java, replacer, reserved-character, reserved-character-replacer, util, wniemiec, wniemiec-util-java
- Language: Java
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Reserved Character Replacer
Responsible for replacing all characters reserved by the operating system with others according to a mapping.
## ❇ 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):
```
io.github.wniemiec-util-java
reserved-character-replacer
LATEST
```
#### Using GitHub Packages:
```
wniemiec.util.java
reserved-character-replacer
LATEST
```
2. Run
```
$ mvn install
```
3. 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](https://github.com/williamniemiec/wniemiec-util-java/reserved-character-replacer/releases).
## 🤝 Contribute!
See the documentation on how you can contribute to the project [here](https://github.com/wniemiec-util-java/reserved-character-replacer/blob/master/CONTRIBUTING.md).
## 📁 Files
### /
| Name |Type|Description|
|----------------|-------------------------------|-----------------------------|
|dist |`Directory`|Released versions|
|docs |`Directory`|Documentation files|
|src |`Directory`| Source files|