Skip to content

Commit

Permalink
Update content 2023-04-21 01:56:29
Browse files Browse the repository at this point in the history
  • Loading branch information
yevgen-nykytenko committed Apr 21, 2023
1 parent 512aa13 commit ae3d210
Show file tree
Hide file tree
Showing 56 changed files with 767 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ This class helps customising [Cache](../../com.groupdocs.viewer.caching/cache).
| [newLine(String line, double x, double y, double width, double height, List<Word> words)](#newLine-java.lang.String-double-double-double-double-java.util.List-com.groupdocs.viewer.results.Word--) | Creates implementation of Line interface |
| [newAttachment(String fileName, String filePath)](#newAttachment-java.lang.String-java.lang.String-) | Creates implementation of LotusNotesViewInfo interface |
| [newAttachment(String id, String fileName, String filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-long-) | Creates implementation of LotusNotesViewInfo interface |
| [newAttachment(String id, String fileName, Path filePath, long size)](#newAttachment-java.lang.String-java.lang.String-java.nio.file.Path-long-) | Creates implementation of LotusNotesViewInfo interface |
| [newAttachment(String id, String fileName, String filePath, FileType fileType, long size)](#newAttachment-java.lang.String-java.lang.String-java.lang.String-com.groupdocs.viewer.FileType-long-) | Creates implementation of LotusNotesViewInfo interface |
| [newOutlookViewInfo(FileType fileType, List<Page> pages, List<String> folders)](#newOutlookViewInfo-com.groupdocs.viewer.FileType-java.util.List-com.groupdocs.viewer.results.Page--java.util.List-java.lang.String--) | Creates implementation of LotusNotesViewInfo interface |
| [newPage(int number, boolean visible)](#newPage-int-boolean-) | Creates implementation of LotusNotesViewInfo interface |
Expand Down Expand Up @@ -265,6 +266,24 @@ Creates implementation of LotusNotesViewInfo interface
| filePath | java.lang.String | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |
| size | long | size |

**Returns:**
[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation
### newAttachment(String id, String fileName, Path filePath, long size) {#newAttachment-java.lang.String-java.lang.String-java.nio.file.Path-long-}
```
public Attachment newAttachment(String id, String fileName, Path filePath, long size)
```


Creates implementation of LotusNotesViewInfo interface

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| id | java.lang.String | id |
| fileName | java.lang.String | file name |
| filePath | java.nio.file.Path | Attachment relative path e.g. folder/file.docx or filename when the file is located in the root of an archive, in e-mail message or data file. |
| size | long | size |

**Returns:**
[Attachment](../../com.groupdocs.viewer.results/attachment) - new instance of [Attachment](../../com.groupdocs.viewer.results/attachment) implementation
### newAttachment(String id, String fileName, String filePath, FileType fileType, long size) {#newAttachment-java.lang.String-java.lang.String-java.lang.String-com.groupdocs.viewer.FileType-long-}
Expand Down
7 changes: 4 additions & 3 deletions english/java/com.groupdocs.viewer.caching/cache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Defines methods required for storing rendered document and document resources \\
| Method | Description |
| --- | --- |
| [set(String key, Object value)](#set-java.lang.String-java.lang.Object-) | Inserts a cache entry into the cache. |
| [<T>get(String key)](#-T-get-java.lang.String-) | Gets the entry associated with this key if present and null otherwise. |
| [<T>get(String key, Class<T> clazz)](#-T-get-java.lang.String-java.lang.Class-T--) | Gets the entry associated with this key if present and null otherwise. |
| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all keys matching filter. |
### set(String key, Object value) {#set-java.lang.String-java.lang.Object-}
```
Expand All @@ -31,9 +31,9 @@ Inserts a cache entry into the cache.
| key | java.lang.String | A unique identifier for the cache entry. |
| value | java.lang.Object | The object to insert. |

### <T>get(String key) {#-T-get-java.lang.String-}
### <T>get(String key, Class<T> clazz) {#-T-get-java.lang.String-java.lang.Class-T--}
```
public abstract T <T>get(String key)
public abstract T <T>get(String key, Class<T> clazz)
```


Expand All @@ -43,6 +43,7 @@ Gets the entry associated with this key if present and null otherwise.
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |
| clazz | java.lang.Class<T> | |

**Returns:**
T - Object if the key was found and null otherwise.
Expand Down
10 changes: 5 additions & 5 deletions english/java/com.groupdocs.viewer.caching/cachekeys/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ public class CacheKeys
```

Provides methods to retrieve unique identifier for the cache entry.
## Constructors
## Fields

| Constructor | Description |
| Field | Description |
| --- | --- |
| [CacheKeys()](#CacheKeys--) | |
| [PAGE_NUMBER](#PAGE-NUMBER) | |
## Methods

| Method | Description |
Expand All @@ -30,9 +30,9 @@ Provides methods to retrieve unique identifier for the cache entry.
| [getPageKey(int pageNumber, String extension)](#getPageKey-int-java.lang.String-) | Returns unique identifier for the cache entry that represents page file. |
| [getResourceKey(int pageNumber, Resource resource)](#getResourceKey-int-com.groupdocs.viewer.results.Resource-) | Returns unique identifier for the cache entry that represents [Resource](../../com.groupdocs.viewer.results/resource) object. |
| [getResourceFilter(int pageNumber)](#getResourceFilter-int-) | Returns filter string to search for cache entries that represents [Resource](../../com.groupdocs.viewer.results/resource) objects. |
### CacheKeys() {#CacheKeys--}
### PAGE_NUMBER {#PAGE-NUMBER}
```
public CacheKeys()
public static final String PAGE_NUMBER
```


Expand Down
47 changes: 44 additions & 3 deletions english/java/com.groupdocs.viewer.caching/filecache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,22 @@ Represents a local on-disk cache.
| Constructor | Description |
| --- | --- |
| [FileCache(String cachePath)](#FileCache-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. |
| [FileCache(Path cachePath)](#FileCache-java.nio.file.Path-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. |
| [FileCache(String cachePath, String cacheSubFolder)](#FileCache-java.lang.String-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. |
| [FileCache(Path cachePath, String cacheSubFolder)](#FileCache-java.nio.file.Path-java.lang.String-) | Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class. |
## Fields

| Field | Description |
| --- | --- |
| [CACHE_PATH](#CACHE-PATH) | |
## Methods

| Method | Description |
| --- | --- |
| [getCachePath()](#getCachePath--) | The Relative or absolute path to the cache folder. |
| [getCacheSubFolder()](#getCacheSubFolder--) | The sub-folder to append to the \#getCachePath().getCachePath(). |
| [set(String key, Object value)](#set-java.lang.String-java.lang.Object-) | Serializes data to the local disk. |
| [<T>get(String key)](#-T-get-java.lang.String-) | Deserializes data associated with this key if present. |
| [<T>get(String key, Class<T> clazz)](#-T-get-java.lang.String-java.lang.Class-T--) | Deserializes data associated with this key if present. |
| [getKeys(String filter)](#getKeys-java.lang.String-) | Returns all file names that contains filter in filename. |
| [getWaitTimeout()](#getWaitTimeout--) | |
| [setWaitTimeout(System.TimeSpan waitTimeout)](#setWaitTimeout-com.aspose.ms.System.TimeSpan-) | |
Expand All @@ -46,6 +53,19 @@ Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache
| --- | --- | --- |
| cachePath | java.lang.String | Relative or absolute path where document cache will be stored. |

### FileCache(Path cachePath) {#FileCache-java.nio.file.Path-}
```
public FileCache(Path cachePath)
```


Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | Relative or absolute path where document cache will be stored. |

### FileCache(String cachePath, String cacheSubFolder) {#FileCache-java.lang.String-java.lang.String-}
```
public FileCache(String cachePath, String cacheSubFolder)
Expand All @@ -60,6 +80,26 @@ Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache
| cachePath | java.lang.String | Relative or absolute path where document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to cachePath . |

### FileCache(Path cachePath, String cacheSubFolder) {#FileCache-java.nio.file.Path-java.lang.String-}
```
public FileCache(Path cachePath, String cacheSubFolder)
```


Creates new instance of [FileCache](../../com.groupdocs.viewer.caching/filecache) class.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| cachePath | java.nio.file.Path | Relative or absolute path where document cache will be stored. |
| cacheSubFolder | java.lang.String | The sub-folder to append to cachePath . |

### CACHE_PATH {#CACHE-PATH}
```
public static final String CACHE_PATH
```


### getCachePath() {#getCachePath--}
```
public final String getCachePath()
Expand Down Expand Up @@ -94,9 +134,9 @@ Serializes data to the local disk.
| key | java.lang.String | An unique identifier for the cache entry. |
| value | java.lang.Object | The object to serialize. |

### <T>get(String key) {#-T-get-java.lang.String-}
### <T>get(String key, Class<T> clazz) {#-T-get-java.lang.String-java.lang.Class-T--}
```
public final T <T>get(String key)
public final T <T>get(String key, Class<T> clazz)
```


Expand All @@ -106,6 +146,7 @@ Deserializes data associated with this key if present.
| Parameter | Type | Description |
| --- | --- | --- |
| key | java.lang.String | A key identifying the requested entry. |
| clazz | java.lang.Class<T> | |

**Returns:**
T - The located value or null.
Expand Down
1 change: 1 addition & 0 deletions english/java/com.groupdocs.viewer.exception/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The package provides classes for exceptions which can occur while working with a

| Class | Description |
| --- | --- |
| [ArchiveSecurityException](../com.groupdocs.viewer.exception/archivesecurityexception) | The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions. |
| [FileNotFoundException](../com.groupdocs.viewer.exception/filenotfoundexception) | Represents the the exception that throws when file or directory was not found. |
| [GroupDocsViewerException](../com.groupdocs.viewer.exception/groupdocsviewerexception) | Represents the generic errors that occur during document processing. |
| [IncorrectPasswordException](../com.groupdocs.viewer.exception/incorrectpasswordexception) | The exception that is thrown when specified password is incorrect. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: ArchiveSecurityException
second_title: GroupDocs.Viewer for Java API Reference
description: The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions.
type: docs
weight: 10
url: /java/com.groupdocs.viewer.exception/archivesecurityexception/
---
**Inheritance:**
java.lang.Object, java.lang.Throwable, java.lang.Exception, java.lang.RuntimeException, com.aspose.ms.System.Exception, com.groupdocs.foundation.exception.GroupDocsException, [com.groupdocs.viewer.exception.GroupDocsViewerException](../../com.groupdocs.viewer.exception/groupdocsviewerexception)
```
public class ArchiveSecurityException extends GroupDocsViewerException
```

The exception that is thrown when archive that is being opened exceeds any of the limits specified in com.groupdocs.viewer.options.ArchiveSecurityOptions.
## Constructors

| Constructor | Description |
| --- | --- |
| [ArchiveSecurityException(String message)](#ArchiveSecurityException-java.lang.String-) | Creates an instance of an exception. |
### ArchiveSecurityException(String message) {#ArchiveSecurityException-java.lang.String-}
```
public ArchiveSecurityException(String message)
```


Creates an instance of an exception.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| message | java.lang.String | The message. |

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FileNotFoundException
second_title: GroupDocs.Viewer for Java API Reference
description: Represents the the exception that throws when file or directory was not found.
type: docs
weight: 10
weight: 11
url: /java/com.groupdocs.viewer.exception/filenotfoundexception/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GroupDocsViewerException
second_title: GroupDocs.Viewer for Java API Reference
description: Represents the generic errors that occur during document processing.
type: docs
weight: 11
weight: 12
url: /java/com.groupdocs.viewer.exception/groupdocsviewerexception/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IncorrectPasswordException
second_title: GroupDocs.Viewer for Java API Reference
description: The exception that is thrown when specified password is incorrect.
type: docs
weight: 12
weight: 13
url: /java/com.groupdocs.viewer.exception/incorrectpasswordexception/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: NotSupportedException
second_title: GroupDocs.Viewer for Java API Reference
description: The exception that is thrown when the operation is not supported.
type: docs
weight: 13
weight: 14
url: /java/com.groupdocs.viewer.exception/notsupportedexception/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: PasswordRequiredException
second_title: GroupDocs.Viewer for Java API Reference
description: The exception that is thrown when password is required to load the document.
type: docs
weight: 14
weight: 15
url: /java/com.groupdocs.viewer.exception/passwordrequiredexception/
---
**Inheritance:**
Expand Down
18 changes: 18 additions & 0 deletions english/java/com.groupdocs.viewer.logging/filelogger/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Writes log messages to the file.
| --- | --- |
| [FileLogger(String fileName)](#FileLogger-java.lang.String-) | Create logger to file. |
| [FileLogger(String fileName, boolean isTraceEnabled, boolean isDebugEnabled, boolean isWarningEnabled, boolean isErrorEnabled)](#FileLogger-java.lang.String-boolean-boolean-boolean-boolean-) | Create logger to file. |
## Fields

| Field | Description |
| --- | --- |
| [MESSAGE](#MESSAGE) | |
| [EXCEPTION](#EXCEPTION) | |
## Methods

| Method | Description |
Expand Down Expand Up @@ -68,6 +74,18 @@ Create logger to file.
| isWarningEnabled | boolean | |
| isErrorEnabled | boolean | |

### MESSAGE {#MESSAGE}
```
public static final String MESSAGE
```


### EXCEPTION {#EXCEPTION}
```
public static final String EXCEPTION
```


### trace(String message, Object[] arguments) {#trace-java.lang.String-java.lang.Object...-}
```
public void trace(String message, Object[] arguments)
Expand Down
1 change: 1 addition & 0 deletions english/java/com.groupdocs.viewer.options/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The package provides classes to specify additional options when rendering docume
| Class | Description |
| --- | --- |
| [ArchiveOptions](../com.groupdocs.viewer.options/archiveoptions) | Provides options for rendering archive files. |
| [ArchiveSecurityOptions](../com.groupdocs.viewer.options/archivesecurityoptions) | Class that can be used to limit archives extraction process. |
| [BaseViewOptions](../com.groupdocs.viewer.options/baseviewoptions) | Provides base rendering options. |
| [CadOptions](../com.groupdocs.viewer.options/cadoptions) | Provides options for rendering CAD drawings. |
| [EmailOptions](../com.groupdocs.viewer.options/emailoptions) | Provides options for rendering email messages. |
Expand Down
Loading

0 comments on commit ae3d210

Please sign in to comment.