Skip to content

Commit

Permalink
Update content 2023-04-20 10:53:41
Browse files Browse the repository at this point in the history
  • Loading branch information
yevgen-nykytenko committed Apr 20, 2023
1 parent 0c9bf39 commit f422bb2
Show file tree
Hide file tree
Showing 45 changed files with 312 additions and 97 deletions.
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
7 changes: 4 additions & 3 deletions english/java/com.groupdocs.viewer.caching/filecache/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Represents a local on-disk cache.
| [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 Down Expand Up @@ -134,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 @@ -146,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
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: ArchiveSecurityOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Class that can be used to limit archives extraction process.
type: docs
weight: 11
url: /java/com.groupdocs.viewer.options/archivesecurityoptions/
---
**Inheritance:**
java.lang.Object
```
public class ArchiveSecurityOptions
```

Class that can be used to limit archives extraction process.

Note: Not each archive type supports all options.
## Constructors

| Constructor | Description |
| --- | --- |
| [ArchiveSecurityOptions()](#ArchiveSecurityOptions--) | |
## Methods

| Method | Description |
| --- | --- |
| [getMaxAllowedEntryNameLength()](#getMaxAllowedEntryNameLength--) | Archive entry name length can not be more than specified in this option. |
| [setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)](#setMaxAllowedEntryNameLength-int-) | Archive entry name length can not be more than specified in this option. |
| [getMaxAllowedEntrySize()](#getMaxAllowedEntrySize--) | Archive entry size can not be more than specified in this option. |
| [setMaxAllowedEntrySize(long maxAllowedEntrySize)](#setMaxAllowedEntrySize-long-) | Archive entry size can not be more than specified in this option. |
| [getMaxAllowedEntriesCount()](#getMaxAllowedEntriesCount--) | Archive that contains more entries, than specified in this option can not be extracted. |
| [setMaxAllowedEntriesCount(long maxAllowedEntriesCount)](#setMaxAllowedEntriesCount-long-) | Archive that contains more entries, than specified in this option can not be extracted. |
| [getMaxAllowedEntryCompressionRatio()](#getMaxAllowedEntryCompressionRatio--) | Archive entries which compression ratio is more, than specified in this option can not be extracted. |
| [setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)](#setMaxAllowedEntryCompressionRatio-double-) | Archive entries which compression ratio is more, than specified in this option can not be extracted. |
### ArchiveSecurityOptions() {#ArchiveSecurityOptions--}
```
public ArchiveSecurityOptions()
```


### getMaxAllowedEntryNameLength() {#getMaxAllowedEntryNameLength--}
```
public int getMaxAllowedEntryNameLength()
```


Archive entry name length can not be more than specified in this option. Default value is 255.

**Returns:**
int - Maximum archive entry name length
### setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength) {#setMaxAllowedEntryNameLength-int-}
```
public void setMaxAllowedEntryNameLength(int maxAllowedEntryNameLength)
```


Archive entry name length can not be more than specified in this option. Default value is 255.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryNameLength | int | Maximum archive entry name length. |

### getMaxAllowedEntrySize() {#getMaxAllowedEntrySize--}
```
public long getMaxAllowedEntrySize()
```


Archive entry size can not be more than specified in this option. Default value is 10Gb (10737418240L).

**Returns:**
long - Maximum archive entry size.
### setMaxAllowedEntrySize(long maxAllowedEntrySize) {#setMaxAllowedEntrySize-long-}
```
public void setMaxAllowedEntrySize(long maxAllowedEntrySize)
```


Archive entry size can not be more than specified in this option. Default value is 10Gb (10737418240L).

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntrySize | long | Maximum archive entry size |

### getMaxAllowedEntriesCount() {#getMaxAllowedEntriesCount--}
```
public long getMaxAllowedEntriesCount()
```


Archive that contains more entries, than specified in this option can not be extracted. Default value is 1000.

**Returns:**
long - Maximum count of entries in an archive.
### setMaxAllowedEntriesCount(long maxAllowedEntriesCount) {#setMaxAllowedEntriesCount-long-}
```
public void setMaxAllowedEntriesCount(long maxAllowedEntriesCount)
```


Archive that contains more entries, than specified in this option can not be extracted. Default value is 1000.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntriesCount | long | Maximum count of entries in an archive. |

### getMaxAllowedEntryCompressionRatio() {#getMaxAllowedEntryCompressionRatio--}
```
public double getMaxAllowedEntryCompressionRatio()
```


Archive entries which compression ratio is more, than specified in this option can not be extracted. Default value is 100.

**Returns:**
double - Maximum allowed entries compression ratio.
### setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio) {#setMaxAllowedEntryCompressionRatio-double-}
```
public void setMaxAllowedEntryCompressionRatio(double maxAllowedEntryCompressionRatio)
```


Archive entries which compression ratio is more, than specified in this option can not be extracted. Default value is 100.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| maxAllowedEntryCompressionRatio | double | Maximum allowed entries compression ratio. |

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: BaseViewOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Provides base rendering options.
type: docs
weight: 11
weight: 12
url: /java/com.groupdocs.viewer.options/baseviewoptions/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CadOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Provides options for rendering CAD drawings.
type: docs
weight: 12
weight: 13
url: /java/com.groupdocs.viewer.options/cadoptions/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: EmailOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Provides options for rendering email messages.
type: docs
weight: 13
weight: 14
url: /java/com.groupdocs.viewer.options/emailoptions/
---
**Inheritance:**
Expand Down
2 changes: 1 addition & 1 deletion english/java/com.groupdocs.viewer.options/field/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Field
second_title: GroupDocs.Viewer for Java API Reference
description: Represents email message fields e46g46 From To Subject etc.
type: docs
weight: 36
weight: 37
url: /java/com.groupdocs.viewer.options/field/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: FileName
second_title: GroupDocs.Viewer for Java API Reference
description: Represents name of simple file
type: docs
weight: 14
weight: 15
url: /java/com.groupdocs.viewer.options/filename/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: HtmlViewOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Provides options for rendering documents into HTML format.
type: docs
weight: 15
weight: 16
url: /java/com.groupdocs.viewer.options/htmlviewoptions/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ImageQuality
second_title: GroupDocs.Viewer for Java API Reference
description: The quality of images in the output HTML contained by the PDF documents.
type: docs
weight: 37
weight: 38
url: /java/com.groupdocs.viewer.options/imagequality/
---
**Inheritance:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IMaxSizeOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Limits of image size options interface.
type: docs
weight: 35
weight: 36
url: /java/com.groupdocs.viewer.options/imaxsizeoptions/
---```
public interface IMaxSizeOptions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: JpgViewOptions
second_title: GroupDocs.Viewer for Java API Reference
description: Provides options for rendering documents into JPG format.
type: docs
weight: 16
weight: 17
url: /java/com.groupdocs.viewer.options/jpgviewoptions/
---
**Inheritance:**
Expand Down
Loading

0 comments on commit f422bb2

Please sign in to comment.