Jackson - Classe JsonParser
introduction
JsonParser est la classe de base pour définir l'API publique pour la lecture du contenu Json. Les instances sont créées à l'aide des méthodes d'usine d'une instance JsonFactory.
Déclaration de classe
Voici la déclaration pour com.fasterxml.jackson.core.JsonParser classe:
public abstract class JsonParser
extends Object
implements Closeable, VersionedClasses imbriquées
| SN | Classe et description |
|---|---|
| 1 | static class JsonParser.Feature Énumération qui définit toutes les fonctionnalités basculantes pour les analyseurs. |
| 2 | static class JsonParser.NumberType Énumération des types "natifs" (optimaux) possibles qui peuvent être utilisés pour les nombres. |
Des champs
protected int _features - Indicateur de bits composé de bits indiquant les fonctionnalités JsonParser.Features activées.
Constructeurs
| SN | Constructeur et description |
|---|---|
| 1 | protected JsonParser () Constructeur par défaut |
| 2 | protected JsonParser (fonctionnalités int) |
Méthodes de classe
| SN | Méthode et description |
|---|---|
| 1 | protected JsonParseException _constructError(String msg) - Méthode d'assistance pour la construction d'exceptions JsonParseExceptions en fonction de l'état actuel de l'analyseur. |
| 2 | protected void _reportUnsupportedOperation() - Méthode d'assistance pour appeler des opérations qui ne sont pas prises en charge par l'implémentation de l'analyseur. |
| 3 | boolean canReadObjectId() - Méthode d'introspection qui peut être appelée pour voir si le format de données sous-jacent prend en charge un certain type d'ID d'objet de manière native (beaucoup ne le font pas; par exemple, JSON ne le fait pas). |
| 4 | boolean canReadTypeId() - Méthode d'introspection qui peut être appelée pour voir si le format de données sous-jacent prend en charge un certain type d'ID de type de manière native (beaucoup ne le font pas; par exemple, JSON ne le fait pas). |
| 5 | boolean canUseSchema(FormatSchema schema) - Méthode qui peut être utilisée pour vérifier que le schéma donné peut être utilisé avec cet analyseur (en utilisant setSchema (com.fasterxml.jackson.core.FormatSchema)). |
| 6 | abstract void clearCurrentToken() - Méthode appelée pour "consommer" le jeton actuel en le supprimant efficacement afin que hasCurrentToken () retourne false, et getCurrentToken () null). |
| sept | abstract void close()- Ferme l'analyseur afin qu'aucune itération ou accès aux données ne puisse être effectué; fermera également la source d'entrée sous-jacente si l'analyseur possède la source d'entrée ou si la fonction JsonParser.Feature.AUTO_CLOSE_SOURCE est activée. |
| 8 | JsonParser configure(JsonParser.Feature f, boolean state) - Méthode d'activation ou de désactivation de la fonctionnalité spécifiée (consultez JsonParser.Feature pour la liste des fonctionnalités) |
| 9 | JsonParser disable(JsonParser.Feature f) - Méthode de désactivation de la fonctionnalité spécifiée (consultez JsonParser.Feature pour la liste des fonctionnalités) |
| dix | JsonParser enable(JsonParser.Feature f) - Méthode d'activation de la fonctionnalité d'analyseur spécifiée (consultez JsonParser.Feature pour la liste des fonctionnalités) |
| 11 | abstract BigInteger getBigIntegerValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_INT et il ne peut pas être utilisé comme un type primitif long Java en raison de sa magnitude. |
| 12 | byte[] getBinaryValue() - Alternative pratique à getBinaryValue (Base64Variant) qui utilise par défaut Base64Variants.getDefaultVariant () comme encodage par défaut. |
| 13 | abstract byte[] getBinaryValue(Base64Variant b64variant) - Méthode qui peut être utilisée pour lire (et consommer - les résultats peuvent ne pas être accessibles à l'aide d'autres méthodes après l'appel) des données binaires encodées en base64 incluses dans la valeur JSON textuelle actuelle. |
| 14 | boolean getBooleanValue() - Accesseur de commodité qui peut être appelé lorsque le jeton actuel est JsonToken.VALUE_TRUE ou JsonToken.VALUE_FALSE. |
| 15 | byte getByteValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_INT et il peut être exprimé comme une valeur de type primitif octet Java. |
| 16 | abstract ObjectCodec getCodec() - Accesseur pour ObjectCodec associé à cet analyseur, le cas échéant. |
| 17 | abstract JsonLocation getCurrentLocation()- Méthode qui renvoie l'emplacement du dernier caractère traité; généralement à des fins de rapport d'erreurs. |
| 18 | abstract String getCurrentName()- Méthode qui peut être appelée pour obtenir le nom associé au jeton courant: pour JsonToken.FIELD_NAMEs, ce sera la même chose que ce que getText () retourne; pour les valeurs de champ, il précédera le nom du champ; et pour les autres (valeurs de tableau, valeurs de niveau racine) null. |
| 19 | abstract JsonToken getCurrentToken()- Accessor pour trouver vers quel analyseur de jeton pointe actuellement, le cas échéant; null sera retourné si aucun. |
| 20 | abstract int getCurrentTokenId() - Méthode similaire à getCurrentToken () mais qui renvoie un int au lieu de JsonToken (valeur enum). |
| 21 | abstract BigDecimal getDecimalValue() - Accesseur numérique qui peut être appelé lorsque le token courant est de type JsonToken.VALUE_NUMBER_FLOAT ou JsonToken.VALUE_NUMBER_INT. |
| 22 | abstract double getDoubleValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_FLOAT et il peut être exprimé comme un type primitif double Java. |
| 23 | abstract Object getEmbeddedObject() - Accesseur qui peut être appelé si (et seulement si) le jeton actuel est JsonToken.VALUE_EMBEDDED_OBJECT. |
| 24 | int getFeatureMask() - Méthode d'accès en bloc pour obtenir l'état de toutes les fonctionnalités JsonParser.Features standard. |
| 25 | abstract float getFloatValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_FLOAT et il peut être exprimé comme un type primitif Java float. |
| 26 | Object getInputSource()- Méthode qui peut être utilisée pour accéder à l'objet qui est utilisé pour accéder à l'entrée en cours d'analyse; il s'agit généralement d'InputStream ou de Reader, en fonction de l'analyseur avec lequel l'analyseur a été construit. |
| 27 | abstract int getIntValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_INT et il peut être exprimé comme une valeur de type primitif Java int. |
| 28 | abstract JsonToken getLastClearedToken() - Méthode qui peut être appelée pour obtenir le dernier jeton qui a été effacé à l'aide de clearCurrentToken (). |
| 29 | abstract long getLongValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_INT et il peut être exprimé comme un type primitif long Java. |
| 30 | abstract JsonParser.NumberType getNumberType()- Si le jeton actuel est de type JsonToken.VALUE_NUMBER_INT ou JsonToken.VALUE_NUMBER_FLOAT, renvoie l'une des constantes JsonParser.NumberType; sinon retourne null. |
| 31 | abstract Number getNumberValue() - Méthode d'accès à la valeur numérique générique qui fonctionnera pour toutes sortes de valeurs numériques. |
| 32 | Object getObjectId() - Méthode qui peut être appelée pour vérifier si le jeton actuel (celui qui vient d'être lu) a un identifiant d'objet associé, et si oui, le renvoyer. |
| 33 | abstract JsonStreamContext getParsingContext() - La méthode qui peut être utilisée pour accéder au lecteur de contexte d'analyse actuel est utilisée. |
| 34 | FormatSchema getSchema() - Méthode d'accès au schéma que cet analyseur utilise, le cas échéant. |
| 35 | short getShortValue() - Accesseur numérique qui peut être appelé lorsque le jeton courant est de type JsonToken.VALUE_NUMBER_INT et il peut être exprimé comme une valeur de type primitif court Java. |
| 36 | abstract String getText()- Méthode d'accès à la représentation textuelle du jeton actuel; si aucun jeton actuel (avant le premier appel à nextToken (), ou après avoir rencontré la fin de l'entrée), renvoie null. |
| 37 | abstract char[] getTextCharacters() - Méthode similaire à getText (), mais qui retournera un tableau de caractères sous-jacent (non modifiable) contenant une valeur textuelle, au lieu de construire un objet String pour contenir ces informations. |
| 38 | abstract int getTextLength() - Accesseur utilisé avec getTextCharacters (), pour connaître la longueur de String stockée dans le tampon retourné. |
| 39 | abstract int getTextOffset() - Accesseur utilisé avec getTextCharacters (), pour connaître le décalage du premier caractère de contenu de texte dans la mémoire tampon. |
| 40 | abstract JsonLocation getTokenLocation()- Méthode qui renvoie l'emplacement de départ du jeton actuel; c'est-à-dire la position du premier caractère à partir de l'entrée qui démarre le jeton actuel. |
| 41 | Object getTypeId() - Méthode qui peut être appelée pour vérifier si le jeton actuel (celui qui vient d'être lu) a un identifiant de type associé, et si c'est le cas, le renvoyer. |
| 42 | boolean getValueAsBoolean() - Méthode qui essaiera de convertir la valeur du jeton actuel en booléen. |
| 43 | boolean getValueAsBoolean(boolean defaultValue) - Méthode qui essaiera de convertir la valeur du jeton actuel en booléen. |
| 44 | double getValueAsDouble() - Méthode qui tentera de convertir la valeur du jeton actuel en un double Java. |
| 45 | double getValueAsDouble(double defaultValue) - Méthode qui tentera de convertir la valeur du jeton actuel en un double Java. |
| 46 | int getValueAsInt() - Méthode qui essaiera de convertir la valeur du jeton actuel en un entier. |
| 47 | int getValueAsInt(int defaultValue) - Méthode qui essaiera de convertir la valeur du jeton actuel en un entier. |
| 48 | long getValueAsLong() - Méthode qui essaiera de convertir la valeur du jeton actuel en un long. |
| 49 | long getValueAsLong(long defaultValue) - Méthode qui essaiera de convertir la valeur du jeton actuel en un long. |
| 50 | String getValueAsString() - Méthode qui essaiera de convertir la valeur du jeton actuel en chaîne. |
| 51 | abstract String getValueAsString(String defaultValue) - Méthode qui essaiera de convertir la valeur du jeton actuel en chaîne. |
| 52 | abstract boolean hasCurrentToken() - Méthode pour vérifier si l'analyseur pointe actuellement vers un jeton (et les données pour ce jeton sont disponibles). |
| 53 | abstract boolean hasTextCharacters() - Méthode qui peut être utilisée pour déterminer si l'appel de getTextCharacters () serait le moyen le plus efficace d'accéder au contenu textuel vers lequel l'analyseur d'événements pointe actuellement. |
| 54 | abstract boolean isClosed() - Méthode qui peut être appelée pour déterminer si cet analyseur est fermé ou non. |
| 55 | boolean isEnabled(JsonParser.Feature f) - Méthode pour vérifier si JsonParser.Feature spécifié est activé. |
| 56 | boolean isExpectedStartArrayToken() - Accesseur spécialisé qui peut être utilisé pour vérifier que le jeton actuel indique le tableau de départ (ce qui signifie généralement que le jeton actuel est JsonToken.START_ARRAY) lorsque le tableau de départ est attendu. |
| 57 | Boolean nextBooleanValue()- La méthode qui récupère le jeton suivant (comme pour appeler nextToken ()) et s'il s'agit de JsonToken.VALUE_TRUE ou JsonToken.VALUE_FALSE renvoie la valeur booléenne correspondante; sinon, retourne null. |
| 58 | boolean nextFieldName(SerializableString str) - Méthode qui récupère le jeton suivant (comme pour appeler nextToken ()) et vérifie s'il s'agit de JsonToken.FIELD_NAME avec le nom spécifié et retourne le résultat de cette comparaison. |
| 59 | int nextIntValue(int defaultValue)- La méthode qui récupère le jeton suivant (comme pour appeler nextToken ()) et s'il s'agit de JsonToken.VALUE_NUMBER_INT renvoie la valeur int 32 bits; sinon renvoie la valeur par défaut spécifiée. Elle est fonctionnellement équivalente à: |
| 60 | long nextLongValue(long defaultValue)- La méthode qui récupère le jeton suivant (comme pour appeler nextToken ()) et s'il s'agit de JsonToken.VALUE_NUMBER_INT renvoie une valeur longue de 64 bits; sinon renvoie la valeur par défaut spécifiée. Elle est fonctionnellement équivalente à: |
| 61 | String nextTextValue()- Méthode qui récupère le jeton suivant (comme pour appeler nextToken ()) et s'il s'agit de JsonToken.VALUE_STRING renvoie la valeur String contenue; sinon retourne null. |
| 62 | abstract JsonToken nextToken() - Méthode d'itération principale, qui avancera suffisamment le flux pour déterminer le type du jeton suivant, le cas échéant. |
| 63 | abstract JsonToken nextValue() - Méthode d'itération qui fera avancer suffisamment le flux pour déterminer le type du prochain jeton qui est un type de valeur (y compris les marqueurs de début / fin de tableau JSON et d'objet). |
| 64 | abstract void overrideCurrentName(String name) - Méthode qui peut être utilisée pour changer ce qui est considéré comme le nom (champ) actuel. |
| 65 | int readBinaryValue(Base64Variant b64variant, OutputStream out) - Similaire à readBinaryValue (OutputStream) mais permet de spécifier explicitement la variante base64 à utiliser. |
| 66 | int readBinaryValue(OutputStream out) - Méthode qui peut être utilisée comme alternative à getBigIntegerValue (), en particulier lorsque la valeur peut être grande. |
| 67 | <T> T readValueAs(Class<T> valueType) - Méthode pour désérialiser le contenu JSON dans un type non-conteneur (il peut cependant s'agir d'un type tableau): généralement un bean, un tableau ou un type wrapper (comme Boolean). |
| 68 | <T> T readValueAs(TypeReference<?> valueTypeRef)- Méthode pour désérialiser le contenu JSON en un type Java, dont la référence est passée en argument. |
| 69 | <T extends TreeNode> T readValueAsTree() - Méthode pour désérialiser le contenu JSON en "modèle d'arbre" équivalent, représenté par le TreeNode racine du modèle résultant. |
| 70 | <T> Iterator<T> readValuesAs(Class<T> valueType) - Méthode de lecture de la séquence d'objets à partir du flux d'analyseur, tous avec le même type de valeur spécifié. |
| 71 | <T> Iterator<T> readValuesAs(TypeReference<?> valueTypeRef)- Méthode de lecture de la séquence d'objets à partir du flux d'analyseur, tous avec le même type de valeur spécifié. |
| 72 | int releaseBuffered(OutputStream out) - Méthode qui peut être appelée pour repousser tout contenu qui a été lu mais non consommé par l'analyseur. |
| 73 | int releaseBuffered(Writer w) - Method that can be called to push back any content that has been read but not consumed by the parser. |
| 74 | boolean requiresCustomCodec() - Méthode qui peut être appelée pour déterminer si un ObjectCodec personnalisé est nécessaire pour la liaison des données analysées à l'aide de JsonParser construit par cette fabrique (ce qui implique généralement la même chose pour la sérialisation avec JsonGenerator). |
| 75 | abstract void setCodec(ObjectCodec c) - Setter qui permet de définir ObjectCodec associé à cet analyseur, le cas échéant. |
| 76 | JsonParser setFeatureMask(int mask) - Méthode de jeu en bloc pour (re) régler les états de tous les JsonParser standard. |
| 77 | void setSchema(FormatSchema schema) - Méthode à appeler pour que cet analyseur utilise le schéma spécifié. |
| 78 | abstract JsonParser skipChildren() - Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY. |
| 79 | abstract Version version() - Accesseur pour obtenir la version du package principal, étant donné une instance de l'analyseur. |
Méthodes héritées
Cette classe hérite des méthodes des classes suivantes:
java.lang.Object