45 lines
1.5 KiB
C#
45 lines
1.5 KiB
C#
#region Apache License 2.0
|
|
/*
|
|
Nuclex .NET Framework
|
|
Copyright (C) 2002-2024 Markus Ewald / Nuclex Development Labs
|
|
|
|
Licensed 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.
|
|
*/
|
|
#endregion // Apache License 2.0
|
|
|
|
using System;
|
|
|
|
namespace Nuclex.Support.Collections {
|
|
|
|
/// <summary>Allows an object to be returned to its initial state</summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// This interface is typically implemented by objects which can be recycled
|
|
/// in order to avoid the construction overhead of a heavyweight class and to
|
|
/// eliminate garbage by reusing instances.
|
|
/// </para>
|
|
/// <para>
|
|
/// Recyclable objects should have a parameterless constructor and calling
|
|
/// their Recycle() method should bring them back into the state they were
|
|
/// in right after they had been constructed.
|
|
/// </para>
|
|
/// </remarks>
|
|
public interface IRecyclable {
|
|
|
|
/// <summary>Returns the object to its initial state</summary>
|
|
void Recycle();
|
|
|
|
}
|
|
|
|
} // namespace Nuclex.Support.Collections
|