Class LookupError
- java.lang.Object
-
- com.dropbox.core.v2.files.LookupError
-
public final class LookupError extends java.lang.ObjectThis class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()methods will returntrue. You can usetag()to determine the tag associated with this instance.Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classLookupError.SerializerFor internal use only.static classLookupError.TagDiscriminating tag type forLookupError.
-
Field Summary
Fields Modifier and Type Field Description static LookupErrorLOCKEDThe given path is locked.static LookupErrorNOT_FILEWe were expecting a file, but the given path refers to something that isn't a file.static LookupErrorNOT_FOLDERWe were expecting a folder, but the given path refers to something that isn't a folder.static LookupErrorNOT_FOUNDThere is nothing at the given path.static LookupErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static LookupErrorRESTRICTED_CONTENTThe file cannot be transferred because the content is restricted.static LookupErrorUNSUPPORTED_CONTENT_TYPEThis operation is not supported for this content type.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)java.lang.StringgetMalformedPathValue()The given path does not satisfy the required path format.inthashCode()booleanisLocked()booleanisMalformedPath()booleanisNotFile()booleanisNotFolder()booleanisNotFound()booleanisOther()booleanisRestrictedContent()booleanisUnsupportedContentType()Returnstrueif this instance has the tagLookupError.Tag.UNSUPPORTED_CONTENT_TYPE,falseotherwise.static LookupErrormalformedPath()Returns an instance ofLookupErrorthat has its tag set toLookupError.Tag.MALFORMED_PATH.static LookupErrormalformedPath(java.lang.String value)Returns an instance ofLookupErrorthat has its tag set toLookupError.Tag.MALFORMED_PATH.LookupError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
NOT_FOUND
public static final LookupError NOT_FOUND
There is nothing at the given path.
-
NOT_FILE
public static final LookupError NOT_FILE
We were expecting a file, but the given path refers to something that isn't a file.
-
NOT_FOLDER
public static final LookupError NOT_FOLDER
We were expecting a folder, but the given path refers to something that isn't a folder.
-
RESTRICTED_CONTENT
public static final LookupError RESTRICTED_CONTENT
The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.
-
UNSUPPORTED_CONTENT_TYPE
public static final LookupError UNSUPPORTED_CONTENT_TYPE
This operation is not supported for this content type.
-
LOCKED
public static final LookupError LOCKED
The given path is locked.
-
OTHER
public static final LookupError OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.
-
-
Method Detail
-
tag
public LookupError.Tag tag()
Returns the tag for this instance.This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the
isXyz()methods will returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisLookupError.If a tag returned by the server is unrecognized by this SDK, the
LookupError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isMalformedPath
public boolean isMalformedPath()
- Returns:
trueif this instance is tagged asLookupError.Tag.MALFORMED_PATH,falseotherwise.
-
malformedPath
public static LookupError malformedPath(java.lang.String value)
Returns an instance ofLookupErrorthat has its tag set toLookupError.Tag.MALFORMED_PATH.The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
LookupErrorwith its tag set toLookupError.Tag.MALFORMED_PATH.
-
malformedPath
public static LookupError malformedPath()
Returns an instance ofLookupErrorthat has its tag set toLookupError.Tag.MALFORMED_PATH.The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.
- Returns:
- Instance of
LookupErrorwith its tag set toLookupError.Tag.MALFORMED_PATH.
-
getMalformedPathValue
public java.lang.String getMalformedPathValue()
The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.This instance must be tagged as
LookupError.Tag.MALFORMED_PATH.- Returns:
- The
Stringvalue associated with this instance ifisMalformedPath()istrue. - Throws:
java.lang.IllegalStateException- IfisMalformedPath()isfalse.
-
isNotFound
public boolean isNotFound()
- Returns:
trueif this instance is tagged asLookupError.Tag.NOT_FOUND,falseotherwise.
-
isNotFile
public boolean isNotFile()
- Returns:
trueif this instance is tagged asLookupError.Tag.NOT_FILE,falseotherwise.
-
isNotFolder
public boolean isNotFolder()
- Returns:
trueif this instance is tagged asLookupError.Tag.NOT_FOLDER,falseotherwise.
-
isRestrictedContent
public boolean isRestrictedContent()
- Returns:
trueif this instance is tagged asLookupError.Tag.RESTRICTED_CONTENT,falseotherwise.
-
isUnsupportedContentType
public boolean isUnsupportedContentType()
Returnstrueif this instance has the tagLookupError.Tag.UNSUPPORTED_CONTENT_TYPE,falseotherwise.- Returns:
trueif this instance is tagged asLookupError.Tag.UNSUPPORTED_CONTENT_TYPE,falseotherwise.
-
isLocked
public boolean isLocked()
- Returns:
trueif this instance is tagged asLookupError.Tag.LOCKED,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asLookupError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
toStringMultiline
public java.lang.String toStringMultiline()
Returns a String representation of this object formatted for easier readability.The returned String may contain newlines.
- Returns:
- Formatted, multiline String representation of this object
-
-