WPinternals/DiscUtils/Ntfs/Internals/GenericAttribute.cs

//
// Copyright (c) 2008-2011, Kenneth Bell
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//

namespace DiscUtils.Ntfs.Internals
{
    /// <summary>
    /// Base class for all attributes within Master File Table entries.
    /// </summary>
    /// <remarks>
    /// More specialized base classes are provided for known attribute types.
    /// </remarks>
    public abstract class GenericAttribute
    {
        private INtfsContext _context;
        private AttributeRecord _record;

        internal GenericAttribute(INtfsContext context, AttributeRecord record)
        {
            _context = context;
            _record = record;
        }

        /// <summary>
        /// Gets the name of the attribute (if any).
        /// </summary>
        public string Name
        {
            get { return _record.Name; }
        }

        /// <summary>
        /// Gets the type of the attribute.
        /// </summary>
        public AttributeType AttributeType
        {
            get { return _record.AttributeType; }
        }

        /// <summary>
        /// Gets the unique id of the attribute.
        /// </summary>
        public int Identifier
        {
            get { return _record.AttributeId; }
        }

        /// <summary>
        /// Gets a value indicating whether the attribute content is stored in the MFT record itself.
        /// </summary>
        public bool IsResident
        {
            get { return !_record.IsNonResident; }
        }

        /// <summary>
        /// Gets the flags indicating how the content of the attribute is stored.
        /// </summary>
        public AttributeFlags Flags
        {
            get { return (AttributeFlags)_record.Flags; }
        }

        /// <summary>
        /// Gets the amount of valid data in the attribute's content.
        /// </summary>
        public long ContentLength
        {
            get { return _record.DataLength; }
        }

        /// <summary>
        /// Gets a buffer that can access the content of the attribute.
        /// </summary>
        public IBuffer Content
        {
            get
            {
                IBuffer rawBuffer = _record.GetReadOnlyDataBuffer(_context);
                return new SubBuffer(rawBuffer, 0, _record.DataLength);
            }
        }

        internal static GenericAttribute FromAttributeRecord(INtfsContext context, AttributeRecord record)
        {
            switch (record.AttributeType)
            {
                case AttributeType.AttributeList:
                    return new AttributeListAttribute(context, record);
                case AttributeType.FileName:
                    return new FileNameAttribute(context, record);
                case AttributeType.StandardInformation:
                    return new StandardInformationAttribute(context, record);
                default:
                    return new UnknownAttribute(context, record);
            }
        }
    }
}