azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.file.shar...

155 строки
9.9 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.file.share.models.FileRange"
fullName: "com.azure.storage.file.share.models.FileRange"
name: "FileRange"
nameWithType: "FileRange"
summary: "An Azure Storage file range."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **FileRange**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.storage.file.share.models.FileRange.FileRange()"
fullName: "com.azure.storage.file.share.models.FileRange.FileRange()"
name: "FileRange()"
nameWithType: "FileRange.FileRange()"
summary: "Creates an instance of File<wbr>Range class."
syntax: "public FileRange()"
desc: "Creates an instance of FileRange class."
methods:
- uid: "com.azure.storage.file.share.models.FileRange.fromXml(com.azure.xml.XmlReader)"
fullName: "com.azure.storage.file.share.models.FileRange.fromXml(XmlReader xmlReader)"
name: "fromXml(XmlReader xmlReader)"
nameWithType: "FileRange.fromXml(XmlReader xmlReader)"
summary: "Reads an instance of File<wbr>Range from the Xml<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The XmlReader being read."
name: "xmlReader"
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static FileRange fromXml(XmlReader xmlReader)"
exceptions:
- description: "If the deserialized XML object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
desc: "Reads an instance of FileRange from the XmlReader."
returns:
description: "An instance of FileRange if the XmlReader was pointing to an instance of it, or null if it was pointing\n to XML null."
type: "<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.fromXml(com.azure.xml.XmlReader,java.lang.String)"
fullName: "com.azure.storage.file.share.models.FileRange.fromXml(XmlReader xmlReader, String rootElementName)"
name: "fromXml(XmlReader xmlReader, String rootElementName)"
nameWithType: "FileRange.fromXml(XmlReader xmlReader, String rootElementName)"
summary: "Reads an instance of File<wbr>Range from the Xml<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The XmlReader being read."
name: "xmlReader"
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
- description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
name: "rootElementName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static FileRange fromXml(XmlReader xmlReader, String rootElementName)"
exceptions:
- description: "If the deserialized XML object was missing any required properties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
desc: "Reads an instance of FileRange from the XmlReader."
returns:
description: "An instance of FileRange if the XmlReader was pointing to an instance of it, or null if it was pointing\n to XML null."
type: "<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.getEnd()"
fullName: "com.azure.storage.file.share.models.FileRange.getEnd()"
name: "getEnd()"
nameWithType: "FileRange.getEnd()"
summary: "Get the end property: End of the range."
syntax: "public long getEnd()"
desc: "Get the end property: End of the range."
returns:
description: "the end value."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.getStart()"
fullName: "com.azure.storage.file.share.models.FileRange.getStart()"
name: "getStart()"
nameWithType: "FileRange.getStart()"
summary: "Get the start property: Start of the range."
syntax: "public long getStart()"
desc: "Get the start property: Start of the range."
returns:
description: "the start value."
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.setEnd(long)"
fullName: "com.azure.storage.file.share.models.FileRange.setEnd(long end)"
name: "setEnd(long end)"
nameWithType: "FileRange.setEnd(long end)"
summary: "Set the end property: End of the range."
parameters:
- description: "the end value to set."
name: "end"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileRange setEnd(long end)"
desc: "Set the end property: End of the range."
returns:
description: "the FileRange object itself."
type: "<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.setStart(long)"
fullName: "com.azure.storage.file.share.models.FileRange.setStart(long start)"
name: "setStart(long start)"
nameWithType: "FileRange.setStart(long start)"
summary: "Set the start property: Start of the range."
parameters:
- description: "the start value to set."
name: "start"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileRange setStart(long start)"
desc: "Set the start property: Start of the range."
returns:
description: "the FileRange object itself."
type: "<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.toXml(com.azure.xml.XmlWriter)"
fullName: "com.azure.storage.file.share.models.FileRange.toXml(XmlWriter xmlWriter)"
name: "toXml(XmlWriter xmlWriter)"
nameWithType: "FileRange.toXml(XmlWriter xmlWriter)"
parameters:
- name: "xmlWriter"
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
returns:
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.FileRange.toXml(com.azure.xml.XmlWriter,java.lang.String)"
fullName: "com.azure.storage.file.share.models.FileRange.toXml(XmlWriter xmlWriter, String rootElementName)"
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
nameWithType: "FileRange.toXml(XmlWriter xmlWriter, String rootElementName)"
parameters:
- name: "xmlWriter"
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
- name: "rootElementName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
returns:
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An Azure Storage file range."
implements:
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.share.models.FileRange?alt=com.azure.storage.file.share.models.FileRange&text=FileRange\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.storage.file.share.models"
artifact: com.azure:azure-storage-file-share:12.24.0