# ***********************************************
# 
# !!!! DO NOT EDIT !!!!
# 
# This file was auto-generated by Build.PL.
# 
# ***********************************************
# 
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

=encoding utf8

=head1 NAME

Lucy::Store::Folder - Abstract class representing a directory.

=head1 SYNOPSIS

    # Abstract base class.

=head1 DESCRIPTION

A “file” within a Folder might be a real file on disk – or it might be a
RAM buffer.  Similarly, Delete() might delete a file from the file system, or
a key-value pair from a hash, or something else.

The archetypal implementation of Folder,
L<FSFolder|Lucy::Store::FSFolder>, represents a directory on
the file system holding a collection of files.

=head1 INHERITANCE

Lucy::Store::Folder isa Clownfish::Obj.

=cut