{
    "content": [
        {
            "type": "text",
            "text": "# Plucene::Index::FieldInfos (perldoc)\n\n## NAME\n\nPlucene::Index::FieldInfos - a collection of FieldInfo objects\n\n## SYNOPSIS\n\nmy $fis = Plucene::Index::FieldInfos->new($dirname);\nmy $fis = Plucene::Index::FieldInfos->new($dirname, $file);\n$fis->add(Plucene::Document $doc, $indexed);\n$fis->add(Plucene::Index::FieldInfos $otherfis, $indexed);\n$fis->add($name, $indexed);\n$fis->write($path);\nmy @fields = $fis->fields;\nmy $fieldnumber = $fis->fieldnumber($name);\nmy   $fieldinfo = $fis->fieldinfo($name);\nmy   $fieldname = $fis->fieldname($number);\nmy   $numfields = $fis->size;\n\n## DESCRIPTION\n\nThis is a collection of field info objects, which happen to live in the field infos file.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Plucene::Index::FieldInfos",
        "section": "",
        "mode": "perldoc",
        "summary": "Plucene::Index::FieldInfos - a collection of FieldInfo objects",
        "synopsis": "my $fis = Plucene::Index::FieldInfos->new($dirname);\nmy $fis = Plucene::Index::FieldInfos->new($dirname, $file);\n$fis->add(Plucene::Document $doc, $indexed);\n$fis->add(Plucene::Index::FieldInfos $otherfis, $indexed);\n$fis->add($name, $indexed);\n$fis->write($path);\nmy @fields = $fis->fields;\nmy $fieldnumber = $fis->fieldnumber($name);\nmy   $fieldinfo = $fis->fieldinfo($name);\nmy   $fieldname = $fis->fieldname($number);\nmy   $numfields = $fis->size;",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 16,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 48,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Plucene::Index::FieldInfos - a collection of FieldInfo objects\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "my $fis = Plucene::Index::FieldInfos->new($dirname);\nmy $fis = Plucene::Index::FieldInfos->new($dirname, $file);\n\n$fis->add(Plucene::Document $doc, $indexed);\n$fis->add(Plucene::Index::FieldInfos $otherfis, $indexed);\n$fis->add($name, $indexed);\n\n$fis->write($path);\n\nmy @fields = $fis->fields;\n\nmy $fieldnumber = $fis->fieldnumber($name);\nmy   $fieldinfo = $fis->fieldinfo($name);\nmy   $fieldname = $fis->fieldname($number);\nmy   $numfields = $fis->size;\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This is a collection of field info objects, which happen to live in the field infos file.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "new\nmy $fis = Plucene::Index::FieldInfos->new($dirname);\nmy $fis = Plucene::Index::FieldInfos->new($dirname, $file);\n\nThis will create a new Plucene::Index::FieldInfos object with the passed directory and optional\nfilename.\n\nadd\n$fis->add(Plucene::Document $doc, $indexed);\n$fis->add(Plucene::Index::FieldInfos $otherfis, $indexed);\n$fis->add($name, $indexed);\n\nThis will add the fields from a Plucene::Document or a Plucene::Index::FieldsInfos to the field\ninfos file.\n\nIt is also possible to pass the name of a field and have it added to the file.\n\nfieldnumber\nmy $fieldnumber = $fis->fieldnumber($name);\n\nThis will return the field number of the field with $name. If there is no match, then -1 is\nreturned.\n\nfields\nmy @fields = $fis->fields;\n\nThis will return all the fields.\n\nfieldinfo\nmy $fieldinfo = $fis->fieldinfo($name);\n\nThis will return the field info for the field called $name.\n\nfieldname\nmy $fieldname = $fis->fieldname($number);\n\nThis will return the field name for the field whose number is $number.\n\nsize\nmy $numfields = $fis->size;\n\nThis returns the number of field info objects.\n\nwrite\n$fis->write($path);\n\nThis will write the field info objects to $path.\n",
                "subsections": []
            }
        }
    }
}