Skip to content

Commit 55c7fdf

Browse files
yevgen-nykytenkoyevgen-nykytenko
committed
Update file(s) "/." from "groupdocs-parser/Groupdocs.Parser-References"
1 parent 2e61b13 commit 55c7fdf

91 files changed

Lines changed: 3844 additions & 1996 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/sites/groupdocs/parser/english/java/_index.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,17 @@ is_root: true
1010
## Packages
1111
| Package | Description |
1212
| --- | --- |
13-
| [com.groupdocs.parser](./com.groupdocs.parser) | The package provides classes for parsing data from documents. |
14-
| [com.groupdocs.parser.data](./com.groupdocs.parser.data) | The package provides classes which represent parsing results. |
15-
| [com.groupdocs.parser.exceptions](./com.groupdocs.parser.exceptions) | The package provides different exceptions classes. |
16-
| [com.groupdocs.parser.export](./com.groupdocs.parser.export) | The package provides classes that allow users to export data to different formats. |
17-
| [com.groupdocs.parser.licensing](./com.groupdocs.parser.licensing) | The package provides classes to set license or use Metered billing. |
18-
| [com.groupdocs.parser.options](./com.groupdocs.parser.options) | The package provides classes to specify additional options when parsing data from documents. |
19-
| [com.groupdocs.parser.templates](./com.groupdocs.parser.templates) | The package provides classes for creating templates for parsing document data. |
13+
| [com.groupdocs.parser](./com.groupdocs.parser) | The package provides classes for parsing data from documents.
14+
|
15+
| [com.groupdocs.parser.data](./com.groupdocs.parser.data) | The package provides classes which represent parsing results.
16+
|
17+
| [com.groupdocs.parser.exceptions](./com.groupdocs.parser.exceptions) | The package provides different exceptions classes.
18+
|
19+
| [com.groupdocs.parser.export](./com.groupdocs.parser.export) | The package provides classes that allow users to export data to different formats.
20+
|
21+
| [com.groupdocs.parser.licensing](./com.groupdocs.parser.licensing) | The package provides classes to set license or use Metered billing.
22+
|
23+
| [com.groupdocs.parser.options](./com.groupdocs.parser.options) | The package provides classes to specify additional options when parsing data from documents.
24+
|
25+
| [com.groupdocs.parser.templates](./com.groupdocs.parser.templates) | The package provides classes for creating templates for parsing document data.
26+
|

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.data/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ url: /java/com.groupdocs.parser.data/
1010
The package provides classes which represent parsing results.
1111

1212

13+
1314
## Classes
1415

1516
| Class | Description |

‎content/sites/groupdocs/parser/english/java/com.groupdocs.parser.data/containeritem/_index.md‎

Lines changed: 86 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,42 @@ public abstract class ContainerItem
1414

1515
Represents a container item like Zip archive entity, email attachment, PDF Portfolio item and so on.
1616

17-
An instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) class is used as return value of [Parser.getContainer()](../../com.groupdocs.parser/parser\#getContainer--) method. See the usage examples there.
17+
An instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) class is used as return value of [Parser.getContainer()](../../com.groupdocs.parser/parser#getContainer--) method. See the usage examples there.
18+
1819
## Constructors
1920

2021
| Constructor | Description |
2122
| --- | --- |
22-
| [ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata)](#ContainerItem-java.lang.String-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--) | Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item name and directory. |
23-
| [ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata)](#ContainerItem-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--) | Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item full path. |
23+
| [ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata)](#ContainerItem-java.lang.String-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--) | Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item name and directory.
24+
|
25+
| [ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata)](#ContainerItem-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--) | Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item full path.
26+
|
2427
## Methods
2528

2629
| Method | Description |
2730
| --- | --- |
28-
| [getName()](#getName--) | Gets the name of the item. |
29-
| [getDirectory()](#getDirectory--) | Gets the directory of the item. |
30-
| [getFilePath()](#getFilePath--) | Gets the full path of the item. |
31-
| [getSize()](#getSize--) | Gets the size of the item. |
32-
| [getMetadata()](#getMetadata--) | Gets the collection of metadata items. |
33-
| [getMetadataValue(String name)](#getMetadataValue-java.lang.String-) | Gets the metadata value. |
34-
| [openStream()](#openStream--) | Opens the stream of the item content. |
35-
| [openParser()](#openParser--) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content. |
36-
| [openParser(LoadOptions loadOptions)](#openParser-com.groupdocs.parser.options.LoadOptions-) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions). |
37-
| [openParser(LoadOptions loadOptions, ParserSettings parserSettings)](#openParser-com.groupdocs.parser.options.LoadOptions-com.groupdocs.parser.options.ParserSettings-) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions) and [ParserSettings](../../com.groupdocs.parser.options/parsersettings). |
38-
| [detectFileType(FileTypeDetectionMode detectionMode)](#detectFileType-com.groupdocs.parser.options.FileTypeDetectionMode-) | Detects a file type of the container item. |
31+
| [getName()](#getName--) | Gets the name of the item.
32+
|
33+
| [getDirectory()](#getDirectory--) | Gets the directory of the item.
34+
|
35+
| [getFilePath()](#getFilePath--) | Gets the full path of the item.
36+
|
37+
| [getSize()](#getSize--) | Gets the size of the item.
38+
|
39+
| [getMetadata()](#getMetadata--) | Gets the collection of metadata items.
40+
|
41+
| [getMetadataValue(String name)](#getMetadataValue-java.lang.String-) | Gets the metadata value.
42+
|
43+
| [openStream()](#openStream--) | Opens the stream of the item content.
44+
|
45+
| [openParser()](#openParser--) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content.
46+
|
47+
| [openParser(LoadOptions loadOptions)](#openParser-com.groupdocs.parser.options.LoadOptions-) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions).
48+
|
49+
| [openParser(LoadOptions loadOptions, ParserSettings parserSettings)](#openParser-com.groupdocs.parser.options.LoadOptions-com.groupdocs.parser.options.ParserSettings-) | Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions) and [ParserSettings](../../com.groupdocs.parser.options/parsersettings).
50+
|
51+
| [detectFileType(FileTypeDetectionMode detectionMode)](#detectFileType-com.groupdocs.parser.options.FileTypeDetectionMode-) | Detects a file type of the container item.
52+
|
3953
### ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata) {#ContainerItem-java.lang.String-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--}
4054
```
4155
public ContainerItem(String name, String directory, long size, Iterable<MetadataItem> metadata)
@@ -44,13 +58,18 @@ public ContainerItem(String name, String directory, long size, Iterable<Metadata
4458

4559
Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item name and directory.
4660

61+
4762
**Parameters:**
4863
| Parameter | Type | Description |
4964
| --- | --- | --- |
50-
| name | java.lang.String | The name of the item. |
51-
| directory | java.lang.String | The directory of the item. |
52-
| size | long | The size of the item. |
53-
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items. |
65+
| name | java.lang.String | The name of the item.
66+
|
67+
| directory | java.lang.String | The directory of the item.
68+
|
69+
| size | long | The size of the item.
70+
|
71+
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items.
72+
|
5473

5574
### ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata) {#ContainerItem-java.lang.String-long-java.lang.Iterable-com.groupdocs.parser.data.MetadataItem--}
5675
```
@@ -60,12 +79,16 @@ public ContainerItem(String filePath, long size, Iterable<MetadataItem> metadata
6079

6180
Initializes a new instance of [ContainerItem](../../com.groupdocs.parser.data/containeritem) with the item full path.
6281

82+
6383
**Parameters:**
6484
| Parameter | Type | Description |
6585
| --- | --- | --- |
66-
| filePath | java.lang.String | The full path of the item. |
67-
| size | long | The size of the item. |
68-
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items. |
86+
| filePath | java.lang.String | The full path of the item.
87+
|
88+
| size | long | The size of the item.
89+
|
90+
| metadata | java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> | The collection of metadata items.
91+
|
6992

7093
### getName() {#getName--}
7194
```
@@ -75,8 +98,10 @@ public String getName()
7598

7699
Gets the name of the item.
77100

101+
78102
**Returns:**
79103
java.lang.String - A string value that represents the file name of the item (without a directory).
104+
80105
### getDirectory() {#getDirectory--}
81106
```
82107
public String getDirectory()
@@ -85,8 +110,10 @@ public String getDirectory()
85110

86111
Gets the directory of the item.
87112

113+
88114
**Returns:**
89115
java.lang.String - A string value that represents the directory of the item (without a file name).
116+
90117
### getFilePath() {#getFilePath--}
91118
```
92119
public String getFilePath()
@@ -95,8 +122,10 @@ public String getFilePath()
95122

96123
Gets the full path of the item.
97124

125+
98126
**Returns:**
99127
java.lang.String - A string value that represents the full path of the item.
128+
100129
### getSize() {#getSize--}
101130
```
102131
public long getSize()
@@ -105,8 +134,10 @@ public long getSize()
105134

106135
Gets the size of the item.
107136

137+
108138
**Returns:**
109139
long - An integer value that represents the size of the item in bytes.
140+
110141
### getMetadata() {#getMetadata--}
111142
```
112143
public Iterable<MetadataItem> getMetadata()
@@ -115,8 +146,10 @@ public Iterable<MetadataItem> getMetadata()
115146

116147
Gets the collection of metadata items.
117148

149+
118150
**Returns:**
119151
java.lang.Iterable<com.groupdocs.parser.data.MetadataItem> - A collection of [MetadataItem](../../com.groupdocs.parser.data/metadataitem) objects; empty if metadata isn't set.
152+
120153
### getMetadataValue(String name) {#getMetadataValue-java.lang.String-}
121154
```
122155
public String getMetadataValue(String name)
@@ -125,13 +158,16 @@ public String getMetadataValue(String name)
125158

126159
Gets the metadata value.
127160

161+
128162
**Parameters:**
129163
| Parameter | Type | Description |
130164
| --- | --- | --- |
131-
| name | java.lang.String | The name of the metadata. |
165+
| name | java.lang.String | The name of the metadata.
166+
|
132167

133168
**Returns:**
134169
java.lang.String - A string value that represents the value of the metadata item; null if the metadata with this name isn't found.
170+
135171
### openStream() {#openStream--}
136172
```
137173
public abstract InputStream openStream()
@@ -140,8 +176,10 @@ public abstract InputStream openStream()
140176

141177
Opens the stream of the item content.
142178

179+
143180
**Returns:**
144181
java.io.InputStream - A stream with the item content.
182+
145183
### openParser() {#openParser--}
146184
```
147185
public Parser openParser()
@@ -150,8 +188,10 @@ public Parser openParser()
150188

151189
Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content.
152190

191+
153192
**Returns:**
154193
[Parser](../../com.groupdocs.parser/parser) - An instance of [Parser](../../com.groupdocs.parser/parser) class of the item content.
194+
155195
### openParser(LoadOptions loadOptions) {#openParser-com.groupdocs.parser.options.LoadOptions-}
156196
```
157197
public Parser openParser(LoadOptions loadOptions)
@@ -160,13 +200,16 @@ public Parser openParser(LoadOptions loadOptions)
160200

161201
Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions).
162202

203+
163204
**Parameters:**
164205
| Parameter | Type | Description |
165206
| --- | --- | --- |
166-
| loadOptions | [LoadOptions](../../com.groupdocs.parser.options/loadoptions) | The options to open the item content. |
207+
| loadOptions | [LoadOptions](../../com.groupdocs.parser.options/loadoptions) | The options to open the item content.
208+
|
167209

168210
**Returns:**
169211
[Parser](../../com.groupdocs.parser/parser) - An instance of [Parser](../../com.groupdocs.parser/parser) class of the item content.
212+
170213
### openParser(LoadOptions loadOptions, ParserSettings parserSettings) {#openParser-com.groupdocs.parser.options.LoadOptions-com.groupdocs.parser.options.ParserSettings-}
171214
```
172215
public abstract Parser openParser(LoadOptions loadOptions, ParserSettings parserSettings)
@@ -175,14 +218,18 @@ public abstract Parser openParser(LoadOptions loadOptions, ParserSettings parser
175218

176219
Creates the [Parser](../../com.groupdocs.parser/parser) object for the item content with [LoadOptions](../../com.groupdocs.parser.options/loadoptions) and [ParserSettings](../../com.groupdocs.parser.options/parsersettings).
177220

221+
178222
**Parameters:**
179223
| Parameter | Type | Description |
180224
| --- | --- | --- |
181-
| loadOptions | [LoadOptions](../../com.groupdocs.parser.options/loadoptions) | The options to open the item content. |
182-
| parserSettings | [ParserSettings](../../com.groupdocs.parser.options/parsersettings) | The parser settings which are used to customize data extraction. |
225+
| loadOptions | [LoadOptions](../../com.groupdocs.parser.options/loadoptions) | The options to open the item content.
226+
|
227+
| parserSettings | [ParserSettings](../../com.groupdocs.parser.options/parsersettings) | The parser settings which are used to customize data extraction.
228+
|
183229

184230
**Returns:**
185231
[Parser](../../com.groupdocs.parser/parser) - An instance of [Parser](../../com.groupdocs.parser/parser) class of the item content.
232+
186233
### detectFileType(FileTypeDetectionMode detectionMode) {#detectFileType-com.groupdocs.parser.options.FileTypeDetectionMode-}
187234
```
188235
public abstract FileType detectFileType(FileTypeDetectionMode detectionMode)
@@ -191,15 +238,17 @@ public abstract FileType detectFileType(FileTypeDetectionMode detectionMode)
191238

192239
Detects a file type of the container item.
193240

194-
detectionMode parameter provides the ability to control file type detection:
195241

196-
* **Default**. The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.
197-
* **Extension**.The file type is detected only by the file extension.
198-
* **Content**. The file type is detected only by the file content.
242+
detectionMode
243+
parameter provides the ability to control file type detection:
244+
245+
* **Default**. The file type is detected by the file extension; if the file extension isn't recognized, the file type is detected by the file content.
246+
* **Extension**.The file type is detected only by the file extension.
247+
* **Content**. The file type is detected only by the file content.
199248

200249
The following example shows how to detect file type of container item:
201250

202-
```
251+
````
203252
// Create an instance of Parser class
204253
try (Parser parser = new Parser(filePath)) {
205254
// Extract attachments from the container
@@ -217,12 +266,16 @@ The following example shows how to detect file type of container item:
217266
}
218267
}
219268
220-
```
269+
````
270+
271+
221272

222273
**Parameters:**
223274
| Parameter | Type | Description |
224275
| --- | --- | --- |
225-
| detectionMode | [FileTypeDetectionMode](../../com.groupdocs.parser.options/filetypedetectionmode) | Defines a mode of the file type detection. |
276+
| detectionMode | [FileTypeDetectionMode](../../com.groupdocs.parser.options/filetypedetectionmode) | Defines a mode of the file type detection.
277+
|
226278

227279
**Returns:**
228-
[FileType](../../com.groupdocs.parser.options/filetype) - An instance of [FileType](../../com.groupdocs.parser.options/filetype) class; [FileType.Unknown](../../com.groupdocs.parser.options/filetype\#Unknown) if a file type isn't detected.
280+
[FileType](../../com.groupdocs.parser.options/filetype) - An instance of [FileType](../../com.groupdocs.parser.options/filetype) class; [FileType.Unknown](../../com.groupdocs.parser.options/filetype#Unknown) if a file type isn't detected.
281+

0 commit comments

Comments
 (0)