Skip to content

Add ParsingException documentation and update references #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZackFra merged 1 commit into from
Jan 11, 2025
Merged

Add ParsingException documentation and update references #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/exceptions/ParsingException.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ParsingException Class

Custom exception for parsing errors

**Since**

4/9/2024

**Group** Exceptions

**Author** Zackary Frazier

**Inheritance**

Exception

## Constructors
### `ParsingException(message, expected)`

Constructor for a ParsingException

#### Signature
```apex
public ParsingException(String message, String expected)
```

#### Parameters
| Name | Type | Description |
|------|------|-------------|
| message | String | ,[object Object], the message to display |
| expected | String | : ,[object Object], the expected token |
8 changes: 4 additions & 4 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

Generic exception for when something is not found

### [ParsingException](exceptions/ParsingException.md)

Custom exception for parsing errors

### [ValidationException](exceptions/ValidationException.md)

This class is responsible for handling validation exceptions
Expand Down Expand Up @@ -590,10 +594,6 @@ The parser breaks down a SOQL query into an AST, to be fed into the parser (Mock

Contains utility methods for the parser, could probably be refactored out of existance though

### [ParsingException](uncategorized/ParsingException.md)

Custom exception for parsing errors

### [PolymorphicAttributes](uncategorized/PolymorphicAttributes.md)

Attributes for polymorphic SObject
Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/AggregateFuncParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/AliasParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/GroupByParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/LimitParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/NumberParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/OperatorParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/OrderByParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/ParserUtils.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public static String consume(String query, String token)
: String, the query with the token consumed

#### Throws
[ParsingException](ParsingException.md): : if the token is not the first token in the query
[ParsingException](../exceptions/ParsingException.md): : if the token is not the first token in the query

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/QueryParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/UpdateTrackingOrViewStatParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/ValueParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
2 changes: 1 addition & 1 deletion docs/uncategorized/WithDataCategoryParser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public override Intermediary parse(String query)
,[object Object]

#### Throws
[ParsingException](ParsingException.md):
[ParsingException](../exceptions/ParsingException.md):

---

Expand Down
1 change: 1 addition & 0 deletions ...se/parser/sub-parser/ParsingException.cls → ...es/common-exceptions/ParsingException.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
* @description Custom exception for parsing errors
* @author Zackary Frazier
* @since 4/9/2024
* @group Exceptions
*/
public inherited sharing class ParsingException extends Exception {
/**
Expand Down
0 .../sub-parser/ParsingException.cls-meta.xml → ...-exceptions/ParsingException.cls-meta.xml
View file
Open in desktop
File renamed without changes.
Loading