{ "name": "StringField", "comment": "StringField provides a wrapper for variable length String data which is read or\n written to a Record. Strings are always encoded as UTF-8.", "javadoc": "\u003ccode\u003eStringField\u003c/code\u003e provides a wrapper for variable length String data which is read or\n written to a Record. Strings are always encoded as UTF-8.", "static": false, "implements": [], "extends": "db.Field", "fields": [ { "name": "NULL_VALUE", "comment": "Null string field value", "javadoc": "Null string field value", "static": true, "type_long": "db.StringField", "type_short": "StringField", "constant_value": null }, { "name": "INSTANCE", "comment": "Instance intended for defining a Table Schema", "javadoc": "Instance intended for defining a {@link Table} {@link Schema}", "static": true, "type_long": "db.StringField", "type_short": "StringField", "constant_value": null }, { "name": "ENCODING", "comment": "", "javadoc": "", "static": true, "type_long": "java.lang.String", "type_short": "String", "constant_value": null }, { "name": "str", "comment": "", "javadoc": "", "static": false, "type_long": "java.lang.String", "type_short": "String", "constant_value": null }, { "name": "bytes", "comment": "", "javadoc": "", "static": false, "type_long": "byte[]", "type_short": "byte[]", "constant_value": null } ], "methods": [ { "name": "\u003cinit\u003e", "comment": "Construct a String field with an initial value of null.", "javadoc": "Construct a String field with an initial value of null.", "static": false, "params": [], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "\u003cinit\u003e", "comment": "Construct a String field with an initial value of s.", "javadoc": "Construct a String field with an initial value of s.\n@param str initial string value or null", "static": false, "params": [ { "name": "str", "type_long": "java.lang.String", "type_short": "String", "comment": "initial string value or null" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "\u003cinit\u003e", "comment": "Construct a String field with an initial value of s.", "javadoc": "Construct a String field with an initial value of s.\n@param str initial string value or null\n@param immutable true if field value is immutable", "static": false, "params": [ { "name": "str", "type_long": "java.lang.String", "type_short": "String", "comment": "initial string value or null" }, { "name": "immutable", "type_long": "boolean", "type_short": "boolean", "comment": "true if field value is immutable" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "isNull", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "boolean", "type_short": "boolean", "comment": "" }, "throws": [] }, { "name": "setNull", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "getString", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "java.lang.String", "type_short": "String", "comment": "" }, "throws": [] }, { "name": "setString", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "str", "type_long": "java.lang.String", "type_short": "String", "comment": "" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "doSetString", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "str", "type_long": "java.lang.String", "type_short": "String", "comment": "" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "length", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [] }, { "name": "write", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "buf", "type_long": "db.Buffer", "type_short": "Buffer", "comment": "" }, { "name": "offset", "type_long": "int", "type_short": "int", "comment": "" } ], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [ { "type_long": "java.io.IOException", "type_short": "IOException", "comment": "" } ] }, { "name": "read", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "buf", "type_long": "db.Buffer", "type_short": "Buffer", "comment": "" }, { "name": "offset", "type_long": "int", "type_short": "int", "comment": "" } ], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [ { "type_long": "java.io.IOException", "type_short": "IOException", "comment": "" } ] }, { "name": "readLength", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "buf", "type_long": "db.Buffer", "type_short": "Buffer", "comment": "" }, { "name": "offset", "type_long": "int", "type_short": "int", "comment": "" } ], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [ { "type_long": "java.io.IOException", "type_short": "IOException", "comment": "" } ] }, { "name": "isVariableLength", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "boolean", "type_short": "boolean", "comment": "" }, "throws": [] }, { "name": "getFieldType", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "byte", "type_short": "byte", "comment": "" }, "throws": [] }, { "name": "toString", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "java.lang.String", "type_short": "String", "comment": "" }, "throws": [] }, { "name": "getValueAsString", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "java.lang.String", "type_short": "String", "comment": "" }, "throws": [] }, { "name": "equals", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "obj", "type_long": "java.lang.Object", "type_short": "Object", "comment": "" } ], "return": { "type_long": "boolean", "type_short": "boolean", "comment": "" }, "throws": [] }, { "name": "getBinaryData", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "byte[]", "type_short": "byte[]", "comment": "" }, "throws": [] }, { "name": "setBinaryData", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "bytes", "type_long": "byte[]", "type_short": "byte[]", "comment": "" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "truncate", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "length", "type_long": "int", "type_short": "int", "comment": "" } ], "return": { "type_long": "void", "type_short": "void", "comment": "" }, "throws": [] }, { "name": "compareTo", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "o", "type_long": "db.Field", "type_short": "Field", "comment": "" } ], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [] }, { "name": "compareTo", "comment": "", "javadoc": "", "static": false, "params": [ { "name": "buffer", "type_long": "db.buffers.DataBuffer", "type_short": "DataBuffer", "comment": "" }, { "name": "offset", "type_long": "int", "type_short": "int", "comment": "" } ], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [] }, { "name": "copyField", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "db.StringField", "type_short": "StringField", "comment": "" }, "throws": [] }, { "name": "newField", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "db.StringField", "type_short": "StringField", "comment": "" }, "throws": [] }, { "name": "hashCode", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "int", "type_short": "int", "comment": "" }, "throws": [] }, { "name": "getMinValue", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "db.StringField", "type_short": "StringField", "comment": "" }, "throws": [] }, { "name": "getMaxValue", "comment": "", "javadoc": "", "static": false, "params": [], "return": { "type_long": "db.StringField", "type_short": "StringField", "comment": "" }, "throws": [] } ] }