Skip to content

Commit 72b527d

Browse files
committed
chore: update docs
1 parent d2250c0 commit 72b527d

File tree

6 files changed

+319
-196
lines changed

6 files changed

+319
-196
lines changed

.idea/workspace.xml

+7-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/SUMMARY.md

-148
This file was deleted.

docs/classes/CnpjValidator.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,18 @@ import io.github.multiform_validator.CnpjValidator;
1212

1313
public class Main {
1414
public static void main(String[] args) {
15+
System.out.println(cnpjIsTrue()); // true
16+
System.out.println(cnpjIsFalse()); // false
17+
}
18+
19+
public static boolean cnpjIsTrue() {
1520
String cnpjTrue = "69.807.668/0001-41";
21+
return CnpjValidator.cnpjIsValid(cnpjTrue);
22+
}
23+
24+
public static boolean cnpjIsFalse() {
1625
String cnpjFalse = "61.807.661/0001-48";
17-
System.out.println(CnpjValidator.cnpjIsValid(cnpjTrue)); // true
18-
System.out.println(CnpjValidator.cnpjIsValid(cnpjFalse)); // false
26+
return CnpjValidator.cnpjIsValid(cnpjFalse);
1927
}
2028
}
2129
```

docs/classes/CreditCardValidator.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ import io.github.multiform_validator.CreditCardValidator;
1212

1313
public class Main {
1414
public static void main(String[] args) {
15-
String creditCardTrue = "4532 8770 0040 4166";
16-
String creditCardFalse = "4532 8770 0040 4167";
17-
System.out.println(CreditCardValidator.isCreditCardValid(creditCardTrue)); // true
18-
System.out.println(CreditCardValidator.isCreditCardValid(creditCardFalse)); // false
15+
valid();
16+
invalid();
17+
}
18+
19+
private static void valid() {
20+
System.out.println(CreditCardValidator.isCreditCardValid("4532 8770 0040 4166")); // true
21+
}
22+
23+
private static void invalid() {
24+
System.out.println(CreditCardValidator.isCreditCardValid("4532 8770 0040 4167")); // false
1925
}
2026
}
2127
```

docs/classes/FileValidator.md

+68-11
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,85 @@ The `FileValidator` class is used to validate files. It has the following method
2121

2222
## How to use
2323

24+
### isValidAudio
25+
2426
```java
25-
import io.github.multiform_validator.FileValidator;
27+
import static io.github.multiform_validator.FileValidator.isValidAudio;
2628

2729
import java.io.File;
2830

2931
public class Main {
3032
public static void main(String[] args) {
31-
File file = new File("path/to/file");
32-
System.out.println(FileValidator.isValidAudio(file)); // true | false
33-
System.out.println(FileValidator.isValidImage(file)); // true | false
34-
System.out.println(FileValidator.isValidPdf(file)); // true | false
35-
System.out.println(FileValidator.isValidTxt(file)); // true | false
36-
33+
File file = new File("src/main/resources/audio.mp3");
34+
System.out.println(isValidAudio(file)); // true | false
35+
3736
exampleExcludingExtensions();
3837
}
39-
38+
4039
public static void exampleExcludingExtensions() {
41-
File file = new File("path/to/file");
40+
File file = new File("src/main/resources/audio.mp3");
4241
String[] audioExtensions = {"mp3"};
42+
System.out.println(isValidAudio(file, audioExtensions)); // false
43+
}
44+
}
45+
```
46+
47+
### isValidImage
48+
49+
```java
50+
import static io.github.multiform_validator.FileValidator.isValidImage;
51+
52+
import java.io.File;
53+
54+
public class Main {
55+
public static void main(String[] args) {
56+
File file = new File("src/main/resources/image.png");
57+
System.out.println(isValidImage(file)); // true | false
58+
59+
exampleExcludingExtensions();
60+
example2ExcludingExtensions();
61+
}
62+
63+
public static void exampleExcludingExtensions() {
64+
File file = new File("src/main/resources/image.png");
4365
String[] imageExtensions = {"ico", "jpeg", "png"};
44-
System.out.println(FileValidator.isValidAudio(file, audioExtensions)); // true | false
45-
System.out.println(FileValidator.isValidImage(file, imageExtensions)); // false | true
66+
System.out.println(isValidImage(file, imageExtensions)); // false
67+
}
68+
69+
public static void example2ExcludingExtensions() {
70+
File file = new File("src/main/resources/image.png");
71+
String[] imageExtensions = {"ico", "jpeg"};
72+
System.out.println(isValidImage(file, imageExtensions)); // true | false
73+
}
74+
}
75+
```
76+
77+
### isValidPdf
78+
79+
```java
80+
import static io.github.multiform_validator.FileValidator.isValidPdf;
81+
82+
import java.io.File;
83+
84+
public class Main {
85+
public static void main(String[] args) {
86+
File file = new File("src/main/resources/file.pdf");
87+
System.out.println(isValidPdf(file)); // true | false
88+
}
89+
}
90+
```
91+
92+
### isValidTxt
93+
94+
```java
95+
import static io.github.multiform_validator.FileValidator.isValidTxt;
96+
97+
import java.io.File;
98+
99+
public class Main {
100+
public static void main(String[] args) {
101+
File file = new File("src/main/resources/file.txt");
102+
System.out.println(isValidTxt(file)); // true | false
46103
}
47104
}
48105
```

0 commit comments

Comments
 (0)